GET/api/v2/payments/mandates/{mandateId}

Get payment mandate by ID

Company API keys can read a mandate within their company. JWT callers must own the mandate; inaccessible objects return the same 404 as missing objects.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
mandateId (path)unknownYesPayment mandate ID

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
UserIdunknownNo
CompanyIdunknownNo
MaxAmountstringNo
CurrencystringNo
FrequencyMandateFrequencyV2No
StatusMandateStatusV2No
DescriptionstringNo
ExternalReferenceIdstringNo
StartDatestringNo
EndDatestringNo
CreatedAtstringNo
UpdatedAtstringNo

404 — MANDATE_NOT_FOUND: missing or inaccessible mandate.

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/payments/mandates/{mandateId}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.