Direct Debit

Look up a pending signed mandate request

Public lookup of a pending signed mandate request by its emailed token. Rate-limited; returns 404 for unknown, consumed, cancelled, or expired tokens.

GET/dd/mandate-requests/{token}

Public lookup of a pending signed mandate request by its emailed token. Rate-limited; returns 404 for unknown, consumed, cancelled, or expired tokens.


Related endpoints

  • POST /dd/validate — Validate a UK bank account for Direct Debit
  • POST /dd/preview — Preview the Direct Debit collection date chain

Common errors

  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
  • 429 rate_limit_error — code rate_limit_exceeded. Back off using the Retry-After header (whole seconds); X-RateLimit-Reset is a UNIX timestamp in seconds.

Path Parameters

token*string

Signed mandate-request token from the emailed link

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X GET "https://api.revkeen.com/v2/dd/mandate-requests/example" 

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "00000000-0000-4000-8000-000000000001",    "merchant_id": "00000000-0000-4000-8000-000000000001",    "merchant_slug": "string",    "customer_id": "00000000-0000-4000-8000-000000000001",    "invoice_id": "string",    "expires_at": "2019-08-24T14:15:22Z",    "status": "pending_signature",    "merchant": {      "id": "00000000-0000-4000-8000-000000000001",      "slug": "string",      "name": "Example customer"    },    "customer": {      "id": "00000000-0000-4000-8000-000000000001",      "name": "string",      "first_name": "string",      "last_name": "string",      "email": "string",      "phone": "string"    },    "invoice": {      "id": "00000000-0000-4000-8000-000000000001",      "invoice_number": "string",      "total": "string",      "amount_due": "string",      "currency": "string"    }  }}

Put this endpoint to work