GoCardless API API Documentation
4.5 Fulfill a Billing Request
POST {{url}}/billing_requests/{{billing_request}}/actions/fulfil
If a billing request is ready to be fulfilled, call this endpoint to cause it to fulfil, executing the payment.
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": "fulfilled",
"mandate_request": {
"currency": "GBP",
"constraints": null,
"scheme": "bacs",
"sweeping": false,
"verify": "recommended",
"links": {
"mandate": "MD000ZS5QMFZ2K"
},
"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",
"customer_bank_account": "BA000ZP65MCQKN",
"creditor": "CR00007SRS79RW",
"organisation": "OR0000476YPSKV",
"mandate_request": "MRQ0005F4VYDCD5",
"mandate_request_mandate": "MD000ZS5QMFZ2K",
"payment_provider": "PPR0000107MYRVG"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Keebler - Lynch",
"actions": [],
"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
},
"customer_bank_account": {
"id": "BA000ZP65MCQKN",
"created_at": "2024-03-22T21:47:08.721Z",
"account_number_ending": "11",
"account_holder_name": "SAVINGS ACCOUNT",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {
"key1": "Value of metadata stored in the customer bank account object",
"key2": "value2"
},
"enabled": true,
"links": {
"customer": "CU0014DRDJ11FB"
},
"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/fulfil'
ENDPOINTS