Get a mandate signature request

GET /v2/mandate_signature_requests/{id}

Path parameters

  • id string(uuid) Required

    ID of the mandate signature request.


  • 200 application/json


    Hide response attributes Show response attributes object
    • id string(uuid) Required

      ID of the mandate signature request

    • reference string Required

      The unique mandate reference.

      Format should match the following pattern: [A-Za-z0-9+?/\-:().,'\s]{1,35}.

    • scheme string Required

      The mandate scheme.

      Values are b2b or core.

    • debtor_email string Required

      The email address of the debtor.

    • Custom text message included in the email sent to the debtor.

    • The contract reference attached to the mandate. This is optional metadata.

    • status string Required

      Current status of the mandate signature request.

      Values are sent, expired, or completed.

    • language string Required

      The language used for the email and signature page for the debtor.

      Values are french or english. Default value is french.

    • is_deleted boolean Required

      Whether or not this mandate signature request has been deleted.

GET /v2/mandate_signature_requests/{id}
curl \
 -X GET \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
  "id": "61b05c4f-3f72-4951-8c30-a2a9faaa5184",
  "reference": "ABC123DEF",
  "scheme": "core",
  "debtor_email": "",
  "email_custom_message": "Hi John Doe, here's a collection mandate to sign.",
  "contract_reference": "CUST-1234",
  "status": "sent",
  "language": "french",
  "is_deleted": false