Get a mandate by id

Retrieve the full details of a single DebiPay mandate using its unique identifier.

GEThttps://api.debipay.co.za/api/v1/mandates/{id}
Loading code example

Path Parameters

idstringrequired

This endpoint returns the details for one mandate identified by its id path parameter. It is the right choice when you need to inspect a specific mandate record, its status, or the customer and payment details linked to it.

Use this endpoint when you already know the mandate identifier and want a focused lookup rather than a paged collection.

Typical use cases

  • Inspect the record of a newly created mandate.
  • Review mandate details before applying an update or cancellation.
  • Support customer support and reconciliation activities.

Request details

The operation requires a path parameter named id. The generated schema in the right panel shows the full response object returned for a successful request.

Response handling

The response contains the mandate details held by the DebiPay service. Use the generated response model to understand which fields are available for your integration.

If you want to inspect all mandates for a merchant or account, use the collection endpoint together with pagination filters.