Initialise a Billing Request Flow

POST {{url}}/billing_request_flows/{{billing_request_flow}}/actions/initialise

Returns the flow having generated a fresh session token which can be used to power integrations that manipulate the flow.

Initialise a Billing Request Flow API Docs

RESPONSES

status: OK

{"billing_request_flows":{"id":"BRF0002KAWARAKK7YJD7PPE6KY3W4CFP","auto_fulfil":true,"redirect_uri":"https://gocardless.com/","skip_success_screen":false,"exit_uri":"https://developer.gocardless.com/","authorisation_url":"https://pay-sandbox.gocardless.com/billing/static/flow?id=BRF0002KAWARAKK7YJD7PPE6KY3W4CFP","lock_customer_details":false,"lock_bank_account":false,"session_token":"sesh_sandbox_vYmu4X-I1VrZJmHjlhXr6i0Jth3MOTOpnLn5vQrv","expires_at":"2024-03-29T21:02:00.031Z","created_at":"2024-03-22T21:02:00.032Z","links":{"billing_request":"BRQ0005Y9MAF57F"},"config":{"merchant_contact_details":{"email":"help@example.com","phone_number":null,"name":"Ondooo"},"scheme_identifiers":[{"scheme":"autogiro","advance_notice":8,"name":"GoCardless","reference":"3171634","address":"Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB","bank_statement_name":"GoCardless","registered_name":"GoCardless"},{"scheme":"faster_payments","advance_notice":0,"name":"Jemma","reference":"00000","address":"x, x, EC1V 7EN, GB","bank_statement_name":"Jemma","registered_name":"GC re Jemma"},{"scheme":"bacs","advance_notice":3,"name":"Jemma Losh","reference":"234567","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"GC re Jemma Losh"},{"scheme":"becs","advance_notice":0,"name":"Jemma Losh","reference":"488290","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"becs_nz","advance_notice":2,"name":"Jemma Losh","reference":"234789","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"betalingsservice","advance_notice":6,"name":"Jemma Losh","reference":"23456789","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"pad","advance_notice":3,"name":"Jemma Losh","reference":"2345678901","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"sepa_core","advance_notice":3,"name":"Jemma Losh","reference":"DE5162600002101235","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"ach","advance_notice":1,"name":"Jemma Losh","reference":"00000000","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"sepa_credit_transfer","advance_notice":0,"name":"Jemma Losh","reference":"JemmaLosh","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"sepa_instant_credit_transfer","advance_notice":0,"name":"Jemma Losh","reference":"JemmaLosh","address":"X, X, EC1V 7EN, GB","bank_statement_name":"Jemma Losh","registered_name":"Jemma Losh"},{"scheme":"pay_to","advance_notice":0,"name":"GoCardless","reference":"00000000","address":"338-346 Goswell Road, London, EC1V 7LQ, GB","bank_statement_name":"GoCardless","registered_name":"GoCardless"}],"payer_theme":{"address_lookup_item_hover_colour":"#48494C","button_background_colour":"#00A87E","button_border_hover_colour":"#009771","button_text_colour":"#FFFFFF","content_box_background_colour":"#fefefe","content_box_border_colour":"#EAEAEA","footer_copy_text_colour":"#545048","footer_link_text_colour":"#545048","header_background_colour":"#FFFFFF","header_text_colour":"#000000","input_border_focus_colour":"#000000","link_text_colour":"#3179D9","success_content_box_border_colour":"#FFFFFF"},"creditor_logo_url":"https://res.cloudinary.com/gocardless/image/fetch/w_300,h_50,c_limit,dpr_3.0/https://uploads-sandbox.gocardless.com/2ac6908b8f7d0acdc80ae47bcea0bbee.png"},"redirect_flow_id":null,"show_redirect_buttons":true,"lock_currency":true,"prefilled_customer":null,"prefilled_bank_account":null,"language":null,"show_success_redirect_button":false,"customer_details_captured":true,"redirect_origin":null}}