1. Start a hosted set-up session

Creates a hosted Direct Debit set-up session. Redirect your customer to the returned checkoutUrl. This endpoint uses HTTP Basic only; it doesn’t use a hash header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to DD-2026-0042
string
required
Defaults to CUST-000184-MANDATE

Your ID for the mandate.

number
required
Defaults to 40000

The most you can charge in a single debit.

paymentMethods
array of strings
required
Defaults to BANK_ACCOUNT_DIRECT_DEBIT
paymentMethods*
Allowed:
uri
required
Defaults to https://yourstore.com/webhooks/paga
uri
Defaults to https://yourstore.com/mandate/complete
string
Defaults to 50000

Lifetime of the set-up session, in seconds.

string
Defaults to 157680000

Lifetime of the mandate, in seconds. 157680000 is 5 years.

additionalProperties
object
Response

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