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.

Create a Billing Request API Docs

Request Body

{"billing_requests"=>{"mandate_request"=>{"currency"=>"GBP", "scheme"=>"bacs", "verify"=>"minimum"}}}

RESPONSES

status: Created

{"billing_requests":{"id":"BRQ0005YWFEHK3P","created_at":"2024-03-26T17:32:30.426Z","status":"pending","mandate_request":{"currency":"GBP","constraints":null,"scheme":"bacs","sweeping":false,"verify":"minimum","links":{},"metadata":{},"description":null,"payer_requested_dual_signature":false},"payment_request":null,"metadata":null,"links":{"customer":"CU0014G1R1M21C","customer_billing_detail":"CBD000JGVVAXWBG","creditor":"CR000070S65B1S","organisation":"OR00004YQ27G22","mandate_request":"MRQ0005FP55QDMD"},"fallback_enabled":false,"fallback_occurred":false,"sign_flow_url":null,"creditor_name":"Acme Corp","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":"mandate","adapter":"open_banking_gateway_ais"}}],"resources":{"customer":{"id":"CU0014G1R1M21C","created_at":"2024-03-26T17:32:30.416Z","email":null,"given_name":null,"family_name":null,"company_name":null,"language":"en","phone_number":null,"metadata":{}},"customer_billing_detail":{"id":"CBD000JGVVAXWBG","created_at":"2024-03-26T17:32:30.422Z","address_line1":null,"address_line2":null,"address_line3":null,"city":null,"region":null,"postal_code":null,"country_code":null,"swedish_identity_number":null,"danish_identity_number":null}},"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}}}