API Reference

Start Open Banking Flow

post
{protocol}://{domain}/helpdesk/payment/openbanking/flow

Starts the Open Banking Flow with GoCardless.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Reference number of account to user to charge, if x-access-token is sent, this is ignored

Body Params

Contains the required information for starting an Open Banking flow.

string | null

The email address of the account holder. Optional: if omitted, it is resolved from the customer's record using their FCCID.

string | null

The given name of the account holder. Optional: if omitted, it is resolved from the customer's record using their FCCID.

string | null

The family name of the account holder. Optional: if omitted, it is resolved from the customer's record using their FCCID.

number
required

The amount to be paid.

string
required

The start date of the payment plan.

Responses

Updated over 1 year ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago