API Reference

Start Open Banking Flow

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

Starts the Open Banking Flow with GoCardless.

Query Params
integer

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

Body Params
string
required

The email address of the account holder.

string
required

The given name of the account holder.

string
required

The family name of the account holder.

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
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago