GoCardless API API Documentation
Notify Customer of Billing Request
POST {{url}}/billing_requests/{{billing_request}}/actions/notify
Notifies the customer linked to the billing request, asking them to authorise it. Currently, the customer can only be notified by email.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"billing_requests": {
"id": "BRQ0005Y9RXA8EN",
"created_at": "2024-03-22T21:33:00.533Z",
"status": "pending",
"mandate_request": null,
"payment_request": {
"description": "Refined Fresh Chair",
"currency": "GBP",
"amount": 79350,
"min_amount": null,
"max_amount": null,
"default_min_amount": null,
"default_max_amount": null,
"app_fee": null,
"scheme": "faster_payments",
"links": {},
"metadata": {
"postman": "payment-only-br"
},
"flexible_amount": false,
"reference": null,
"funds_settlement": "managed"
},
"metadata": {
"test": "BR861"
},
"links": {
"customer": "CU0014DR96ZN5Q",
"customer_billing_detail": "CBD000JFDY58X71",
"creditor": "CR00006C6DF0TD",
"organisation": "OR00004AE28612",
"payment_request": "PRQ0000RABQ0FAK"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Ondooo",
"actions": [
{
"type": "choose_currency",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed",
"available_currencies": [
"GBP",
"AUD",
"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": "completed",
"collect_customer_details": {
"incomplete_fields": {
"customer": [],
"customer_billing_detail": []
},
"default_country_code": "GB"
}
},
{
"type": "select_institution",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed",
"institution_guess_status": "not_needed"
},
{
"type": "collect_bank_account",
"required": false,
"completes_actions": [
"choose_currency"
],
"available_country_codes": [
"GB"
],
"requires_actions": [
"collect_amount"
],
"status": "pending"
},
{
"type": "bank_authorisation",
"required": true,
"completes_actions": [],
"requires_actions": [
"select_institution"
],
"status": "pending",
"bank_authorisation": {
"authorisation_type": "payment",
"adapter": "open_banking_gateway_pis"
}
}
],
"resources": {
"customer": {
"id": "CU0014DR96ZN5Q",
"created_at": "2024-03-22T21:33:00.504Z",
"email": "jayme47@example.com",
"given_name": "Mile Curl curl -X POST 'https://api-sandbox.gocardless.com/billing_requests/billing_request/actions/notify' -d '{"data":{"notification_type":"email","redirect_uri":"https://example.com"}}' ENDPOINTS |