Logo
GoCardless API API Documentation

Create a Billing Request Flow

POST {{url}}/billing_request_flows

Creates a new billing request flow.

Create a Billing Request Flow API Docs

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "billing_request_flows": { "id": "BRF0000M5KMTPANW9AG56MV3GSMSVT9R", "auto_fulfil": true, "redirect_uri": "https://gocardless.com/", "exit_uri": "https://developer.gocardless.com/", "authorisation_url": "https://pay-sandbox.gocardless.com/billing/static/flow?id=BRF0000M5KMTPANW9AG56MV3GSMSVT9R", "lock_customer_details": false, "lock_bank_account": false, "session_token": null, "expires_at": "2022-11-08T16:28:31.869Z", "created_at": "2022-11-01T16:28:31.873Z", "links": { "billing_request": "BRQ00019RM2676C" }, "config": { "merchant_contact_details": { "email": "solutions@gocardless.com", "phone_number": null }, "scheme_identifiers": [ { "scheme": "bacs", "advance_notice": 3, "name": "GoCardless Ltd", "reference": "275069", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless Ltd" }, { "scheme": "autogiro", "advance_notice": 8, "name": "GoCardless", "reference": "3171634", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "betalingsservice", "advance_notice": 6, "name": "GoCardless", "reference": "09025677", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "becs_nz", "advance_notice": 2, "name": "GoCardless", "reference": "1220559", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "pad", "advance_notice": 3, "name": "GoCardless", "reference": "2185310000", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "ach", "advance_notice": 2, "name": "GoCardless", "reference": "00000000", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "faster_payments", "advance_notice": 0, "name": "GoCardless", "reference": "000000", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, { "scheme": "becs", "advance_notice": 1, "name": "Enterprise Solut", "reference": "484141", "address": "3rd Floor, London, EC1V 7LQ, AU", "bank_statement_name": "Enterprise Solut" }, { "scheme": "sepa_credit_transfer", "advance_notice": 0, "name": "GoCardless", "reference": "00000000", "address": "Sutton Yard, 65 Goswell Road, London, EC1V 7EN, GB", "bank_statement_name": "GoCardless" }, {
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_request_flows' -d '{"billing_request_flows":{"auto_fulfil":true,"lock_currency":true,"lock_bank_account":false,"lock_customer_details":false,"redirect_uri":"https://gocardless.com/","show_redirect_buttons":true,"exit_uri":"https://developer.gocardless.com/","prefilled_customer":{"given_name":"Frank","family_name":"Osborne","email":"frank.osborne@acmeplc.com","address_line1":"65 Goswell Road","city":"London","postal_code":"EC1V 7EN","country_code":"GB"},"links":{"billing_request":"billing_request"}}}'

ENDPOINTS