Changelog
Back to All
added

V2 - SEPA and GoCardless endpoints

June 20th, 2025 by Integrations Squad

Overview

We are happy to announce the introduction of the SEPA and GoCardless mandate management endpoints. This outlines all the available endpoints in the Pennylane V2 API.

Authentication & Scopes

All endpoints require OAuth2 authentication or a developer token with appropriate scopes:

  • Read Operations: customer_mandates:all OR customer_mandates:readonly
  • Write Operations: customer_mandates:all (read-only scope insufficient)

SEPA Mandates Endpoints

1. List SEPA Mandates

  • Route: GET /api/external/v2/sepa_mandates
  • Scopes: customer_mandates:all OR customer_mandates:readonly
  • Description: Retrieve a paginated list of SEPA mandates

2. Get SEPA Mandate Details

  • Route: GET /api/external/v2/sepa_mandates/:id
  • Scopes: customer_mandates:all OR customer_mandates:readonly
  • Description: Retrieve details of a specific SEPA mandate by ID

3. Create SEPA Mandate

  • Route: POST /api/external/v2/sepa_mandates
  • Scopes: customer_mandates:all
  • Description: Create a new SEPA mandate

4. Update SEPA Mandate

  • Route: PUT /api/external/v2/sepa_mandates/:id
  • Scopes: customer_mandates:all
  • Description: Update an existing SEPA mandate

5. Delete SEPA Mandate

  • Route: DELETE /api/external/v2/sepa_mandates/:id
  • Scopes: customer_mandates:all
  • Description: Permanently delete a SEPA mandate

GoCardless Mandates Endpoints

1. List GoCardless Mandates

  • Route: GET /api/external/v2/gocardless_mandates
  • Scopes: customer_mandates:all OR customer_mandates:readonly
  • Description: Retrieve a paginated list of GoCardless mandates for the company

2. Get GoCardless Mandate Details

  • Route: GET /api/external/v2/gocardless_mandates/:id
  • Scopes: customer_mandates:all OR customer_mandates:readonly
  • Description: Retrieve details of a specific GoCardless mandate by ID

3. Cancel GoCardless Mandate

  • Route: POST /api/external/v2/gocardless_mandates/:gocardless_mandate_id/cancellations
  • Scopes: customer_mandates:all
  • Description: Cancel a GoCardless mandate.

4. Associate GoCardless Mandate with Customer

  • Route: POST /api/external/v2/gocardless_mandates/:gocardless_mandate_id/associations
  • Scopes: customer_mandates:all
  • Description: Associate an existing GoCardless mandate with a customer.

5. Send GoCardless Mandate Email Request

  • Route: POST /api/external/v2/gocardless_mandates/mail_requests
  • Scopes: customer_mandates:all
  • Description: Send an email to a customer requesting GoCardless mandate setup