v1

latestOpenAPI 3.0.12026-07-141671231.8 MB

Mandates

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

post/api/external/v2/pro_account/mandate_migrations

Request body

mandate_type'SepaMandate' | 'Mandate' required

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

mandate_idinteger required

The ID of the mandate to migrate.

early_execution_date_permittedboolean

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

Example request

{
  "mandate_type": "Mandate",
  "mandate_id": 12345
}

Response

Mandate migration initiated successfully

Example response

{
  "mandate_migration": {
    "id": 42,
    "status": "pending",
    "direct_debit_method": "GoCardless",
    "signed_at": "2023-08-07T14:23:12.000Z",
    "created_at": "2023-08-07T14:23:12.000Z",
    "updated_at": "2023-08-07T14:23:12.000Z",
    "mandate": {
      "id": 42,
      "type": "SepaMandate"
    },
    "customer": {
      "id": 42,
      "url": "https://app.pennylane.com/api/external/v2/customers/42",
      "pro_account_mandate": {
        "url": "https://app.pennylane.com/api/external/v2/pro_account/mandates?filter=..."
      }
    }
  }
}