INinfinite
Mandates

Get a mandate

Changed on
get/v1/mandates/{mandateId}

Request

Path parameters

mandateIdstring required

Mandate id (mdt_…).

Headers

X-API-Keystring

API key

Response

idstring required
organizationIdstring required
customerIdstring required
namestring required
descriptionstring nullable required
status'ACTIVE' | 'REVOKED' required
allowedPayeeAccountIdsstring[] nullable required
allowedRailsstring[] nullable required
allowedDrafterPrincipalIdsstring[] nullable required
validFromstring required
validUntilstring nullable required
metadataobject required
createdBystring nullable required
createdAtstring required
updatedAtstring required

Example response

{
  "id": "mdt_…"
}

Changes