Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a Mandate
{
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"Culture": "EN",
"ReturnURL": "https://docs.mangopay.com/please-ignore",
"Tag": "Created using the Mangopay API Postman collection"
}
{
"Scheme": null,
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"BankReference": null,
"Culture": "EN",
"DocumentURL": "https://api.sandbox.mangopay.com/webhook/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/document?version=2.01",
"ReturnURL": "https://docs.mangopay.com/please-ignore?MandateId=mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"RedirectURL": "https://api.sandbox.mangopay.com/mvc/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/confirmation?version=2.01",
"Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"CreationDate": 1727962392,
"Status": "CREATED",
"UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
"ExecutionType": "WEB",
"MandateType": "DIRECT_DEBIT",
"Tag": "Created using the Mangopay API Postman collection",
"ResultCode": null,
"ResultMessage": null
}
Note – Mandate expires after 1 hour
If not confirmed within 1 hour of the CreationDate, the Mandate expires with the error 001807 and a new one must be created.
Body parameters
The unique identifier of the bank account.
Warning: The Bank Account Type must be IBAN for the SEPA scheme and GB for the Bacs scheme.
Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL
The language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA Scheme.
Max. length: 220 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
Max. length: 255 characters
Custom data that you can add to this object.
Responses
The scheme of the mandate, which is available once the mandate is submitted. The value can be one of the following:
- BACS – Covers payments in the UK, in GBP only.
- SEPA – Covers payments in the EU.
The unique identifier of the bank account.
Warning: The Bank Account Type must be IBAN for the SEPA scheme and GB for the Bacs scheme.
The banking reference for the Mandate.
Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL
The language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA Scheme.
The URL at which the mandate document can be downloaded.
Max. length: 220 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
The URL to which to redirect the user to complete the payment.
Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
The unique identifier of the object.
The date and time at which the object was created.
Returned values: CREATED, SUBMITTED, ACTIVE, FAILED, EXPIRED
The status of the mandate:
CREATED– The mandate has been generated but not yet confirmed.SUBMITTED– The mandate has been confirmed and sent to the user’s bank, and can be used to request a direct debit pay-in.ACTIVE– The mandate has been accepted by the user’s bank or successfully used to process a direct debit direct pay-in. Further pay-ins can be requested.FAILED– The mandate has been canceled or otherwise failed, and can no longer be used for payments.EXPIRED– No payment has been made against the mandate in the last 24 months. It can no longer be used for payments.
The unique identifier of the User (natural or legal) who owns the bank account.
Returned values: WEB
The execution type of the mandate.
The type of the mandate.
Max. length: 255 characters
Custom data that you can add to this object.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "277c7c4e-baf1-43f8-ba1d-d9f02d7939e2",
"Date": 1727958031.0,
"errors": {
"Culture": "The requested language is not supported for this bank account"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "9d45b954-4eda-4247-b4e3-91027628ab22",
"Date": 1690294898.0,
"errors": {
"Culture": "The requested language is not supported"
}
}
{
"Scheme": null,
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"BankReference": null,
"Culture": "EN",
"DocumentURL": "https://api.sandbox.mangopay.com/webhook/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/document?version=2.01",
"ReturnURL": "https://docs.mangopay.com/please-ignore?MandateId=mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"RedirectURL": "https://api.sandbox.mangopay.com/mvc/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/confirmation?version=2.01",
"Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"CreationDate": 1727962392,
"Status": "CREATED",
"UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
"ExecutionType": "WEB",
"MandateType": "DIRECT_DEBIT",
"Tag": "Created using the Mangopay API Postman collection",
"ResultCode": null,
"ResultMessage": null
}
{
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"Culture": "EN",
"ReturnURL": "https://docs.mangopay.com/please-ignore",
"Tag": "Created using the Mangopay API Postman collection"
}
Was this page helpful?
{
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"Culture": "EN",
"ReturnURL": "https://docs.mangopay.com/please-ignore",
"Tag": "Created using the Mangopay API Postman collection"
}
{
"Scheme": null,
"BankAccountId": "bankacc_m_01J999AWHFHW2PQ1ADNQ46AYE9",
"BankReference": null,
"Culture": "EN",
"DocumentURL": "https://api.sandbox.mangopay.com/webhook/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/document?version=2.01",
"ReturnURL": "https://docs.mangopay.com/please-ignore?MandateId=mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"RedirectURL": "https://api.sandbox.mangopay.com/mvc/eu/public/mandates/e8a73d/dfbdce2a12a442bfae973e56777b3ddb/confirmation?version=2.01",
"Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
"CreationDate": 1727962392,
"Status": "CREATED",
"UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
"ExecutionType": "WEB",
"MandateType": "DIRECT_DEBIT",
"Tag": "Created using the Mangopay API Postman collection",
"ResultCode": null,
"ResultMessage": null
}