Revoke a mandate

POST/v1/mandates/{id}/revoke

Stops new countersigns at once, voids the PayPal hold and moves the mandate to REVOKED. While a countersigned purchase may still be captured, the void waits for it and the revocation completes in the background.

Path parameters

idstringRequired

Headers

idempotency-keystringRequired
Idempotency-KeystringRequired: 1 to 255 characters. A retry with the same key returns the first answer.

Responses

200The mandate is revoked
202The mandate is being revoked
401Not signed in
404No such mandate for this user
409The mandate has already ended
422PayPal refused the void
503PayPal is unavailable

200 response

statestringRequired: One of REVOKED

curl -X POST https://api.keelson.finance/v1/mandates/{id}/revoke \
  -H 'idempotency-key: <idempotency-key>' \
  -H "idempotency-key: $(uuidgen)"

const res = await fetch("https://api.keelson.finance/v1/mandates/{id}/revoke", {
  method: "POST",
  headers: {
    "idempotency-key": "<idempotency-key>",
    "idempotency-key": crypto.randomUUID(),
  },
});
const data = await res.json();

Response · shape from the schema

{
  "state": "REVOKED"
}