GoCardless API API Documentation
4.1 Create a Billing Request (Mandate)
POST {{url}}/billing_requests
Billing Requests help create resources that require input or action from a customer. An example of required input might be additional customer billing details, while an action would be asking a customer to authorise a payment using their mobile banking app. See Billing Requests: Overview for how-to’s, explanations and tutorials.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"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": {
"Key of Metadat": "Value of metadata stored in the mandate object",
"key2": "value2"
},
"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": "pending",
"collect_customer_details": {
"incomplete_fields": {
"customer": [
"email",
"given_name",
"family_name"
],
"customer_billing_detail": [
"address_line1",
"city",
"postal_code",
"country_code"
]
},
"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": &quo Curl curl -X POST 'https://api-sandbox.gocardless.com/billing_requests' -d '{"billing_requests":{"mandate_request":{"currency":"GBP","scheme":"bacs","verify":"recommended","metadata":{"Key of Metadata":"Value of metadata stored in the mandate object","key2":"value2"}},"metadata":{"key":"BR$randomInt"},"links":{"creditor":"creditor"}}}' ENDPOINTS |