Billing
Retrieve a mandate
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
id*string
UUIDv7 identifier of the resource.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/mandates/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "mandate", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a", "provider": "gocardless", "reference": "string", "status": "awaiting_authorisation", "scheme": "bacs", "provider_mandate_ref": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "not_found", "message": "Resource not found." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}