Logo
GoCardless API API Documentation

Create a Billing Request

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.

Create a Billing Request API Docs

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status Created

{ "billing_requests": { "id": "BRQ0006TNHTV0FZ", "created_at": "2024-08-09T14:05:01.215Z", "status": "pending", "mandate_request": { "currency": "GBP", "constraints": null, "scheme": "bacs", "sweeping": false, "verify": "recommended", "links": {}, "metadata": { "key": "value" }, "description": null, "payer_requested_dual_signature": false }, "payment_request": { "description": "Handcrafted Granite Mouse", "currency": "GBP", "amount": 15369, "min_amount": null, "max_amount": null, "default_min_amount": null, "default_max_amount": null, "app_fee": null, "scheme": "faster_payments", "links": {}, "metadata": { "key": "value" }, "flexible_amount": false, "reference": null, "funds_settlement": "managed" }, "metadata": { "test": "BR269" }, "links": { "customer": "CU00181SBYD8FD", "customer_billing_detail": "CBD000N4T2RHJR5", "creditor": "CR0000796J2GYR", "organisation": "OR000056YMCJ5G", "payment_request": "PRQ0000VSWQ9ETG", "mandate_request": "MRQ00069VGEWRTY" }, "fallback_enabled": false, "fallback_occurred": false, "sign_flow_url": null, "auto_fulfil": true, "creditor_name": "Your Company Name", "actions": [ { "type": "choose_currency", "required": true, "completes_actions": [], "requires_actions": [], "status": "completed", "available_currencies": [ "GBP", "EUR" ] }, { "type": "collect_amount", "required": true, "completes_actions": [], "requires_actions": [], "status": "completed" }, { "type": "collect_customer_details", "required": true, "completes_actions": [], "requires_actions": [ "choose_currency", "collect_amount" ], "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": "select_institution", "required": true, "completes_actions": [], "requires_actions": [], "status": "pending", "institution_guess_status": "pending" }, { "type": "collect_bank_account", "required": true, "completes_actions": [ "choose_currency" ], "avail
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_requests'

ENDPOINTS