API Docs / Schemas / CreateMandateSetupRequest

CreateMandateSetupRequest

Starts a direct debit setup (POST /me/billing/mandate-setups).

Properties

Name Type Description
successRedirectUrl*string

Where GoCardless sends the customer's browser once they have completed the setup. GoCardless appends
redirect_flow_id to it; the client then completes the setup with PUT /me/billing/mandate.

Where GoCardless sends the customer's browser once they have completed the setup. GoCardless appends
redirect_flow_id to it; the client then completes the setup with PUT /me/billing/mandate.

JSON Example

{
  "successRedirectUrl": "https://example.com"
}

Used By Operations