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

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"],"available_country_codes":["GB"],"requires_actions":["collect_amount"],"status":"pending"},{"type":"confirm_payer_details","required":true,"completes_actions":[],"requires_actions":["collect_customer_details","collect_bank_account"],"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":"CU00181SBYD8FD","created_at":"2024-08-09T14:05:01.162Z","email":null,"given_name":null,"family_name":null,"company_name":null,"language":"en","phone_number":null,"metadata":{}},"customer_billing_detail":{"id":"CBD000N4T2RHJR5","created_at":"2024-08-09T14:05:01.199Z","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,"is_eligible_for_ibp_direct_bank_link_experiments":false,"is_eligible_for_ibp_v2_single_screen_flow_experiments":false,"is_eligible_for_remove_payer_name_experiments":false}}}