GOgocardless
Billing Request Flow

Initialise a Billing Request Flow

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

post/billing_request_flows/{billing_request_flow_id}/actions/initialise

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

billing_request_flow_idstring required

The billing request flow id

Headers

GoCardless-Versionstring required

Response

Action completed successfully

Example response

{
  "billing_request_flows": {
    "id": "BRF123",
    "redirect_uri": "https://my-website.com/abc/callback",
    "exit_uri": "https://my-website.com/abc/callback",
    "authorisation_url": "https://monzo.com/abc-123-things",
    "session_token": "sesh_123",
    "prefilled_customer": {
      "email": "user@example.com",
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "address_line1": "221B Baker Street",
      "address_line2": "Marylebone",
      "address_line3": "City of Westminster",
      "city": "London",
      "region": "Greater London",
      "postal_code": "NW1 6XE",
      "country_code": "GB",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "220550-6218",
      "language": "en",
      "phone_number": "+44 20 1234 5678"
    },
    "prefilled_bank_account": {
      "account_type": "savings"
    },
    "language": "en",
    "links": {
      "billing_request": "BRQ123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.