Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Mandates

List mandate migration candidates

This endpoint allows you to retrieve all mandate migration candidates for your company. These are mandates that can be migrated to a Pro Account.

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 one of the following scopes: customer_mandates:readonly, customer_mandates:all

get/api/external/v2/pro_account/mandate_migrations

Query parameters

cursorstring
Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

limitinteger
Example:20

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

filterstring
Example:[{"field": "status", "operator": "eq", "value": "available"}]

You can choose to filter items on specific fields. Available fields and values:

  • customer_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • status: lt, lteq, gt, gteq, eq, not_eq, in, not_in
sortstring

You can choose to sort items on specific attributes. Sort field may be prefixed with - for descending order. Example: id will sort by ascending order, -id will sort by descending order. Available fields: id

Response

The list of mandate migration candidates

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring nullable required

Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A null next_cursor in the response indicates no further results.

Example response

{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 42,
      "status": "available",
      "direct_debit_method": "GoCardless",
      "signed_at": "2023-08-07T14:23:12.000Z",
      "mandate": {
        "id": 42,
        "type": "Mandate"
      },
      "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=..."
        }
      },
      "created_at": "2023-08-07T14:23:12.000Z",
      "updated_at": "2023-08-07T14:23:12.000Z"
    }
  ]
}