Revoke a payment mandate
Revoke a payment mandate
Use the following steps to revoke a payment mandate. Revoking a mandate removes the ability to make new payments using the payment mandate. However information about the mandate will still be available to retrieve in the future.
Revoked mandates cannot be reinstated
Once a mandate has been revoked, it cannot be reinstated in future. You must create a new mandate if you wish to set up recurring payments for the user. See mandate creation for details.
Build a revoke mandate request
Requests should be signed
All the requests in this guide should be signed on your server/backend.
All requests need an idempotency key
All the requests in this guide should include an idempotency key. You can learn more about API idempotency.
To revoke a payment mandate, you need to use your client_credentials access token retrieved in previous steps in your Authorization
header, with the Bearer
prefix.
Make an POST request to /mandates/{mandate_id}/revoke
endpoint with the following query parameters :
Parameter | Description |
---|---|
mandate_id | ID of the mandate to revoke |
The body of the request should be empty.
curl --request POST \
--url https://api.truelayer-sandbox.com/mandates/6d4c7a02-2db9-48e6-855a-1733626cc410/revoke \
--header 'Accept: application/problem+json; charset=UTF-8' \
--header 'Idempotency-Key: testidempotencykey' \
--header 'Tl-Signature: testrequestsignature'
If mandate revocation is successsful, then you will receive an HTTP 204 response.
Refer to the API Reference for further information on revoking a payment mandate.
Updated 9 months ago