Summary: New Payment Instrument Mandates endpoints and events for SEPA Direct Debit mandates (preview)

Payment Instrument Mandates

New Endpoints: Create, Confirm, Cancel, List and Get Payment Instrument Mandates

Documented new endpoints to manage the customer's authorization to collect SEPA Direct Debits from one of their bank accounts. A mandate is created with status created and must be confirmed, using Strong Customer Authentication where sca.required is true, before it can be used for collections. A customer account can have at most one confirmed mandate per debtor bank account. When the customer revokes a mandate, cancel it; canceled is terminal.

These endpoints are a preview API and may change without a deprecation period. They are only available if you are enabled for SEPA Direct Debit.

• POST /accounts/{account_id}/payment_instrument_mandates - Create a payment instrument mandate, optionally with an Idempotency-Key header
• POST /accounts/{account_id}/payment_instrument_mandates/{payment_instrument_mandate_id}/confirm - Confirm a payment instrument mandate
• POST /accounts/{account_id}/payment_instrument_mandates/{payment_instrument_mandate_id}/cancel - Cancel a payment instrument mandate
• GET /accounts/{account_id}/payment_instrument_mandates - List payment instrument mandates, optionally filtered by status, type and mandate_reference
• GET /accounts/{account_id}/payment_instrument_mandates/{payment_instrument_mandate_id} - Retrieve a payment instrument mandate

Events

New Events: payment_instrument_mandate.created, payment_instrument_mandate.confirmed, payment_instrument_mandate.canceled and payment_instrument_mandate.rejected

The new events are created when a mandate is created, when it is confirmed, when it is canceled, and when lemon.markets rejects it. They use the new PaymentInstrumentMandateEventContext, which contains only identifiers and no debtor data.

Example context:

{
  "account": "cusa_c2c3f89ec0524b6e818ce00c16e4897f",
  "payment_instrument_mandate": "pinst_mand_f3a42ba00cb84618a549d975662c90b3"
}