Cancel a Billing Request

POST {{url}}/billing_requests/{{billing_request}}/actions/cancel

Immediately cancels a billing request, causing all billing request flows to expire.

Cancel a Billing Request API Docs

 

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key

Datatype

Required

Description

RESPONSES

status OK

{ "billing_requests": { "id": "BRQ0005Y9RTBV78", "created_at": "2024-03-22T21:31:26.133Z", "status": "cancelled", "mandate_request": { "currency": "GBP", "constraints": null, "scheme": "bacs", "sweeping": false, "verify": "recommended", "links": {}, "metadata": { "postman": "mandate-only-br" }, "description": null, "payer_requested_dual_signature": false }, "payment_request": null, "metadata": { "test": "BR1" }, "links": { "customer": "CU0014DR8N0C49", "customer_billing_detail": "CBD000JFDXZ7FQD", "customer_bank_account": "BA000ZP63JF2PP", "creditor": "CR00006C6DF0TD", "organisation": "OR00004AE28612", "mandate_request": "MRQ0005F4V3K31X" }, "fallback_enabled": false, "fallback_occurred": false, "sign_flow_url": null, "creditor_name": "Ondooo", "actions": [], "resources": { "customer": { "id": "CU0014DR8N0C49", "created_at": "2024-03-22T21:31:26.121Z", "email": "linnie_bradtke@example.com", "given_name": "Xander", "family_name": "Graham", "company_name": "Grimes - Kautzer", "language": "en", "phone_number": "+1 617-555-1212", "metadata": { "example_uuid": "f19f95c5-82a2-4989-a00a-caf192055176" } }, "customer_billing_detail": { "id": "CBD000JFDXZ7FQD", "created_at": "2024-03-22T21:31:26.128Z", "address_line1": "0863 Aubree Course", "address_line2": null, "address_line3": null, "city": "South Jermain", "region": null, "postal_code": "E8 3GX", "country_code": "GB", "swedish_identity_number": null, "danish_identity_number": null }, "customer_bank_account": { "id": "BA000ZP63JF2PP", "created_at": "2024-03-22T21:31:31.333Z", "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": "Credit Card Account" }, "enabled": true, "links": { "customer": "CU0014DR8N0C49" }, "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 } } }