GoCardless API API Documentation
4.2 Collect Customer Details
POST {{url}}/billing_requests/{{billing_request}}/actions/collect_customer_details
If the billing request has a pending collectcustomerdetails action, this endpoint can be used to collect the details in order to complete it. The endpoint takes the same payload as Customers, but checks that the customer fields are populated correctly for the billing request scheme. Whatever is provided to this endpoint is used to update the referenced customer, and will take effect immediately after the request is successful. Note: the region field should be uncommented for US customer addresses.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"billing_requests": {
"id": "BRQ0005Y9SSR7JR",
"created_at": "2024-03-22T21:46:58.618Z",
"status": "pending",
"mandate_request": {
"currency": "GBP",
"constraints": null,
"scheme": "bacs",
"sweeping": false,
"verify": "recommended",
"links": {},
"metadata": {
"key2": "value2",
"Key of Metadat": "Value of metadata stored in the mandate object"
},
"description": null,
"payer_requested_dual_signature": false
},
"payment_request": null,
"metadata": {
"key": "BR562"
},
"links": {
"customer": "CU0014DRDJ11FB",
"customer_billing_detail": "CBD000JFDZY7JEY",
"creditor": "CR00007SRS79RW",
"organisation": "OR0000476YPSKV",
"mandate_request": "MRQ0005F4VYDCD5",
"payment_provider": "PPR0000107MYRVG"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Keebler - Lynch",
"actions": [
{
"type": "choose_currency",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed",
"available_currencies": [
"USD",
"SEK",
"GBP",
"AUD",
"NZD",
"DKK",
"CAD",
"EUR"
]
},
{
"type": "collect_customer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"choose_currency"
],
"status": "completed",
"collect_customer_details": {
"incomplete_fields": {
"customer": [],
"customer_billing_detail": []
},
"default_country_code": "GB"
}
},
{
"type": "collect_bank_account",
"required": true,
"completes_actions": [
"choose_currency"
],
"available_country_codes": [
"GB"
],
"requires_actions": [],
"status": "pending"
},
{
"type": "confirm_payer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"collect_customer_details",
"collect_bank_account"
],
"status": "pending"
},
{
"type": "bank_authorisation",
"required": false,
"completes_actions": [
"collect_bank_account"
],
"requires_actions": [
"select_institution"
],
"status": "pending",
"bank_authorisation": {
"authorisation_type": "mandate",
"adapter": "open_banking_gateway_ais"
}
}
],
"resources": {
"customer": {
"id": "CU0014DRDJ11FB",
"created_at": "2024-03-22T21:46:58.602Z",
"email": "moshe_botsford@example.org",
"given_name": "Ardith",
"family_name": "Connelly",
"company_name": null,
"language": "en",
"phone_number": null,
"metadata": {
"key1": "Value of metadata stored in the customer object",
"key2": "value2"
}
},
"customer_billing_detail": {
"id": "CBD000JFDZY7JEY",
"created_at": "2024-03-22T21:46:58.613Z",
"address_line1": "6041 Thiel Extension",
"address_line2": null,
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "E8 3GX",
"country_code": "GB",
"swedish_identity_number": null,
"danish_identity_number": null
}
},
"experimentation": {
"is_eligible_for_share_of_wallet_experiments": false,
"is_eligible_for_optional_vm_experiments": false,
"is_eligible_for_institution_experiments": false,
"is_eligible_for_ach_optional_address_experiments": false,
"is_eligible_for_ach_mx_experiments": false,
"is_eligible_for_single_tab_experiments": false,
"is_eligible_for_bankid_safe_start_experiments": false
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_requests/https://api-sandbox.gocardless.com/actions/collect_customer_details' -d '{"data":{"customer":{"email":"$randomExampleEmail","given_name":"$randomExampleEmail","family_name":"$randomExampleEmail","metadata":{"key1":"Value of metadata stored in the customer object","key2":"value2"}},"customer_billing_detail":{"address_line1":"$randomExampleEmail","city":"London","postal_code":"E8 3GX","country_code":"GB"}}}'
ENDPOINTS