API Docs / Schemas / MandateSetupDto

MandateSetupDto

A started direct debit setup: where to send the customer, and what the client must hold to complete it.

Properties

Name Type Description
redirectFlowId*string

GoCardless's identifier for the setup (its redirect flow); GoCardless also appends it to the success URL

GoCardless's identifier for the setup (its redirect flow); GoCardless also appends it to the success URL

redirectUrl*string

The GoCardless page to send the customer's browser to

The GoCardless page to send the customer's browser to

sessionToken*string

The secret that proves the completing client started the setup; hold it (not in a URL) until completion

The secret that proves the completing client started the setup; hold it (not in a URL) until completion

JSON Example

{
  "redirectFlowId": "string",
  "redirectUrl": "string",
  "sessionToken": "string"
}

Used By Operations