Migrate a mandate to Pro Account

This endpoint allows you to migrate a mandate to a Pro Account. Only mandates with status 'available' are eligible for migration.

Requirements:

  • Company must have a Pro Account (returns 404 if not)
  • Company must have an enabled merchant profile (returns 403 if not)

This endpoint requires the following scope: customer_mandates:all

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of the mandate to migrate. Use "Mandate" for GoCardless mandates or "SepaMandate" for SEPA mandates.

Allowed:
int64
required

The ID of the mandate to migrate.

boolean

Whether to permit early execution date for the migration. Defaults to false if not specified.

Responses

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