Retrieve a Direct Debit mandate
Related endpoints
POST /mandates— Create a Direct Debit mandateGET /mandates— List Direct Debit mandatesPOST /mandates/{id}/cancel— Cancel a Direct Debit mandatePOST /mandates/{id}/suspend— Suspend a Direct Debit mandatePOST /mandates/{id}/reinstate— Reinstate a suspended Direct Debit mandatePOST /mandates/{id}/collections— Schedule a one-off Direct Debit collection
Common errors
401 unauthenticated— missing, malformed, or revoked API key.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Authorization
apiKey x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Mandate ID
Response Body
application/json
application/json
application/json
Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/mandates/string" \
-H "x-api-key: $REVKEEN_API_KEY"{
"data": {
"id": "string",
"mandate_ref": "string",
"mandate_reference": "string",
"customer_id": "string",
"status": "pending_lodgement",
"account_holder_name": "string",
"sort_code": "XX-XX-00",
"account_number_last4": "string",
"bank_name": "string",
"statement_name": "string",
"notice_days": 0,
"first_collection_date": "string",
"next_collection_date": "string",
"backup_payment_method_id": "string",
"activated_at": "string",
"suspended_at": "string",
"cancelled_at": "string",
"failure_reason": "string",
"mandate_request_id": "string",
"invoice_id": "string",
"pdf_documents": [
{
"id": "string",
"mandate_request_id": "string",
"mandate_id": "string",
"customer_id": "string",
"merchant_id": "string",
"pdf_type": "signed_mandate_confirmation",
"storage_key": "string",
"pdf_url": "string",
"generated_at": "string",
"template_version": "string",
"compliance_version": "string"
}
],
"created_at": "string",
"updated_at": "string"
}
}{
"error": "Unauthorized"
}{
"error": "Not found"
}