Create an Instant Payment 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 Request (Instant Bank Pay feature) for how-to’s, explanations and tutorials.

Create a Billing Request API Docs

RESPONSES

status: Created

{"billing_requests":{"id":"BRQ00019S3CR58M","created_at":"2022-11-01T17:03:24.770Z","status":"pending","mandate_request":null,"payment_request":{"description":"Handmade Wooden Chicken","currency":"GBP","amount":27666,"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},"metadata":{"test":"BR123"},"links":{"customer":"CU000Q8VSP2BKY","customer_billing_detail":"CBD00083594VADF","creditor":"CR00004PQYSR68","organisation":"OR000036YNWF31","payment_request":"PRQ0000AD796ZQ8"},"fallback_enabled":false,"fallback_occurred":false,"sign_flow_url":null,"creditor_name":"Enterprise Solutions","actions":[{"type":"choose_currency","required":true,"completes_actions":[],"requires_actions":[],"status":"completed","available_currencies":["USD","SEK","GBP","AUD","NZD","DKK","CAD","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":"pending"},{"type":"collect_bank_account","required":true,"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","requires_institution":true,"direct_to_institution":true,"adapter":"open_banking_gateway_pis"}}],"resources":{"customer":{"id":"CU000Q8VSP2BKY","created_at":"2022-11-01T16:30:33.360Z","email":"myrtis3@example.com","given_name":"Sophia","family_name":"Schroeder","company_name":"Tremblay, Effertz and Mueller","language":"en","phone_number":"+1 617-555-1212","metadata":{"example_uuid":"0aa3bd47-b8ee-40bb-9a56-e750f82d7594"}},"customer_billing_detail":{"id":"CBD00083594VADF","created_at":"2022-11-01T17:03:24.758Z","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}}}