POST/api/v2/payments/mandates

Create a payment mandate

Authentication

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

Request body

application/json

Request body fields
Field	Type	Required
UserId	unknown	Yes
MaxAmount	string	Yes
Currency	string	Yes
Frequency	MandateFrequencyV2	No
Description	string	No
ExternalReferenceId	string	No
StartDate	string	No
EndDate	string	No
Metadata	object	No

Responses

201 — Created

Response 201 fields
Field	Type	Required
Id	unknown	No
UserId	unknown	No
CompanyId	unknown	No
MaxAmount	string	No
Currency	string	No
Frequency	MandateFrequencyV2	No
Status	MandateStatusV2	No
Description	string	No
ExternalReferenceId	string	No
StartDate	string	No
EndDate	string	No
CreatedAt	string	No
UpdatedAt	string	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/payments/mandates" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"UserId":"…","MaxAmount":"…","Currency":"…"}'

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