Mandates

Get a SEPA mandate

Changed on

This endpoint allows you to retrieve a specific SEPA mandate by ID

ℹ️ This endpoint requires one of the following scopes: customer_mandates:all, customer_mandates:readonly

get/api/external/v2/sepa_mandates/{id}

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/sepa_mandates/{id}
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: customer_mandates:all, customer_mandates:readonly

Path parameters

idinteger required

ID of the SEPA mandate to retrieve

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

A SEPA mandate

idinteger required

ID of the created SEPA mandate

bankstring nullable required

Name of the customer's bank

bicstring required

Bank Identifier Code (BIC) of the customer's bank

ibanstring required

International Bank Account Number (IBAN) of the customer

sequence_type'FRST' | 'OOFF' | 'RCUR' | 'FNAL' required

SEPA mandate sequence type that defines the payment process.

  • FRST: First payment in a series of recurring payments
  • OOFF: One-off payment
  • RCUR: Recurring payment that is not the first payment
  • FNAL: Final payment in a series of recurring payments
signed_atstring date required

Date when the mandate was signed

identifierstring required

Unique identifier for the mandate

created_atstring date-time required

Creation date of the SEPA mandate

updated_atstring date-time required

Last update date of the SEPA mandate

Example response

{
  "id": 12345,
  "bank": "BNP Paribas",
  "bic": "BNPAFRPP",
  "iban": "FR3612739000506556687647Z31",
  "sequence_type": "RCUR",
  "signed_at": "2025-04-24",
  "identifier": "K-02-2023-12345",
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customers/42"
  },
  "created_at": "2023-08-07T14:23:12.000Z",
  "updated_at": "2023-08-07T14:23:12.000Z"
}

Changes