GoCardless API API Documentation
Confirm Customer & Bank Account Details
POST {{url}}/billing_requests/{{billing_request}}/actions/confirm_payer_details
This is needed when you have mandate_request. As a scheme compliance rule we are required to allow the payer to crosscheck the details entered by them and confirm it.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"billing_requests": {
"id": "BRQ0005YWFEHK3P",
"created_at": "2024-03-26T17:32:30.426Z",
"status": "ready_to_fulfil",
"mandate_request": {
"currency": "GBP",
"constraints": null,
"scheme": "bacs",
"sweeping": false,
"verify": "minimum",
"links": {},
"metadata": {},
"description": null,
"payer_requested_dual_signature": false
},
"payment_request": null,
"metadata": null,
"links": {
"customer": "CU0014G1R1M21C",
"customer_billing_detail": "CBD000JGVVAXWBG",
"customer_bank_account": "BA000ZQE57BCK0",
"creditor": "CR000070S65B1S",
"organisation": "OR00004YQ27G22",
"mandate_request": "MRQ0005FP55QDMD"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Acme Corp",
"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": "completed"
},
{
"type": "confirm_payer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"collect_customer_details",
"collect_bank_account"
],
"status": "completed"
},
{
"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": "CU0014G1R1M21C",
"created_at": "2024-03-26T17:32:30.416Z",
"email": "remington_quigley@example.org",
"given_name": "Lenora",
"family_name": "Fritsch",
"company_name": null,
"language": "en",
"phone_number": null,
"metadata": {}
},
"customer_billing_detail": {
"id": "CBD000JGVVAXWBG",
"created_at": "2024-03-26T17:32:30.422Z",
"address_line1": "83347 Welch Forge",
"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
},
"customer_bank_account": {
"id": "BA000ZQE57BCK0",
"created_at": "2024-03-26T17:32:45.668Z",
"account_number_ending": "11",
"account_holder_name": "INVESTMENT ACCOUNT",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {},
"enabled": true,
"links": {
"customer": "CU0014G1R1M21C"
},
"branch_code_ending": "00"
}
},
"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/confirm_payer_details'
ENDPOINTS