mandates

Mandates Schedule

post/mandate/schedule

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/mandate/schedule
  • Auth: HTTP bearer

Headers

x-signaturestring required

ES256 request signature. Required on signed-write endpoints, see request signing.

x-tenantstring required
Example:UAE

Regulatory jurisdiction the request routes to (e.g. UAE, KSA, MAIN). Match it to the market you're integrating.

Request body

creditorAccountIdstring
executionDatestring date-time required

ISO 8601 date the payment should execute.

mandateIdstring date-time required

UUID of the mandate this payment draws against.

Example request

{
  "amount": {
    "currency": "AED"
  },
  "executionDate": "2025-01-01T00:00:00Z",
  "mandateId": "2025-01-01T00:00:00Z"
}

Response

Success response

errorstring nullable
errorDescriptionobject nullable

Example response

{
  "data": {
    "executionDate": "2025-01-01T00:00:00Z",
    "mandateId": "2025-01-01T00:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.