Create a new mandate signature request

POST /v2/mandate_signature_requests

An email will be sent to the mandate debtor so they can complete and sign the collection mandate.

application/json

Body Required

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.

Minimum length is 1, maximum length is 256. Format should match the following pattern: ^(?!.*\.\.)[a-zA-Z0-9._%+-]{1,250}@[a-zA-Z0-9.-]{2,250}\.[a-zA-Z]{2,63}$.
email_custom_message string

Custom text message that will be included in the email sent to the debtor.

Minimum length is 1, maximum length is 512. Format should match the following pattern: [a-zA-Zà-üÀ-Ü0-9&;.,?!()+\-'’"\s]*.
contract_reference string

The contract reference that will be attached to the mandate. This is optional metadata.

Minimum length is 1, maximum length is 256.
language string

The language used for the email and signature page for the debtor. This is optional.

Values are french or english. Default value is french.

Responses

200 application/json

OK
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.
- email_custom_message string
  
  Custom text message included in the email sent to the debtor.
- contract_reference string
  
  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.

POST /v2/mandate_signature_requests

curl \
 -X POST https://api.memo.bank/v2/mandate_signature_requests \
 -H "Content-Type: application/json" \
 -d '{"reference":"ABC123DEF","scheme":"core","debtor_email":"foo@bar.com","email_custom_message":"Hi John Doe, here's a collection mandate to sign.","contract_reference":"CUST-1234","language":"french"}'

Request examples

{
  "reference": "ABC123DEF",
  "scheme": "core",
  "debtor_email": "foo@bar.com",
  "email_custom_message": "Hi John Doe, here's a collection mandate to sign.",
  "contract_reference": "CUST-1234",
  "language": "french"
}

Response examples (200)

{
  "id": "61b05c4f-3f72-4951-8c30-a2a9faaa5184",
  "reference": "ABC123DEF",
  "scheme": "core",
  "debtor_email": "foo@bar.com",
  "email_custom_message": "Hi John Doe, here's a collection mandate to sign.",
  "contract_reference": "CUST-1234",
  "status": "sent",
  "language": "french",
  "is_deleted": false
}