GoCardless API API Documentation
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": "BRQ00019RNXYJ5D",
"created_at": "2022-11-01T16:30:33.372Z",
"status": "fulfilled",
"mandate_request": {
"currency": "GBP",
"scheme": "bacs",
"verify": "minimum",
"links": {
"mandate": "MD000PK0CW9TNR"
},
"metadata": {
"key": "value"
},
"payer_requested_dual_signature": false
},
"payment_request": null,
"metadata": {
"test": "BR799"
},
"links": {
"customer": "CU000Q8VSP2BKY",
"customer_billing_detail": "CBD000834NQ5BYY",
"customer_bank_account": "BA000PJZZYSSG8",
"creditor": "CR00004PQYSR68",
"organisation": "OR000036YNWF31",
"mandate_request": "MRQ00013Q7B6YQ9",
"mandate_request_mandate": "MD000PK0CW9TNR"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Enterprise Solutions",
"actions": [],
"resources": {
"customer": {
"id": "CU000Q8VSP2BKY",
"created_at": "2022-11-01T16:30:33.360Z",
"email": "myrtis3@example.com",
"given_name": "Sophia",
"family_name": "Schroeder",
"company_name": "Tremblay, Effertz and Mueller",
"language": "en",
"phone_number": "+1 617-555-1212",
"metadata": {
"example_uuid": "0aa3bd47-b8ee-40bb-9a56-e750f82d7594"
}
},
"customer_billing_detail": {
"id": "CBD000834NQ5BYY",
"created_at": "2022-11-01T16:30:33.368Z",
"address_line1": "531 Christiansen Extensions",
"address_line2": null,
"address_line3": null,
"city": "West Jessyca",
"region": null,
"postal_code": "E8 3GX",
"country_code": "GB",
"swedish_identity_number": null,
"danish_identity_number": null
},
"customer_bank_account": {
"id": "BA000PJZZYSSG8",
"created_at": "2022-11-01T16:30:37.969Z",
"account_number_ending": "11",
"account_holder_name": "HOME LOAN ACCOUNT",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {
"name": "Checking Account"
},
"enabled": true,
"links": {
"customer": "CU000Q8VSP2BKY"
},
"branch_code_ending": "00"
}
},
"experimentation": {
"is_eligible_for_share_of_wallet_experiments": false
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_requests/https://api-sandbox.gocardless.com/actions/fulfil'
ENDPOINTS