Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Mandates

Create a SEPA mandate

This endpoint allows you to create a SEPA mandate to enable direct debit payments

ℹ️ This endpoint requires the following scope: customer_mandates:all

post/api/external/v2/sepa_mandates

Request body

bankstring

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'

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

customer_idinteger required

ID of the customer for which the mandate is created

Example request

{
  "bank": "BNP Paribas",
  "bic": "BNPAFRPP",
  "iban": "FR3612739000506556687647Z31",
  "sequence_type": "RCUR",
  "signed_at": "2025-04-24",
  "identifier": "K-02-2025-12345",
  "customer_id": 47334785
}

Response

Renders the created 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"
}