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
- The Deposit Preauthorization object
- POSTCreate a Deposit Preauthorization
- PUTCancel a Deposit Preauthorization or request a no-show
- GETView a Deposit Preauthorization
- GETList Deposit Preauthorizations for a Card
- GETList Deposit Preauthorizations for a User
- The Deposit Preauthorized PayIn object
- POSTCreate a Deposit Preauthorized PayIn without complement
- POSTCreate a Deposit Preauthorized PayIn prior to complement
- POSTCreate a Deposit Preauthorized PayIn complement
- GETView a PayIn (Deposit Preauthorized Card)
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
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 Deposit Preauthorized PayIn prior to complement
{
"AuthorId": "203063430",
"CreditedWalletId": "203063456",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Tag": "Created using Mangopay API Postman Collection"
}
{
"AuthorId": "203063430",
"CreditedUserId": "203063430",
"CreditedWalletId": "203063456",
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Id": "265d22b6-a3dc-48a4-a685-8655e5bcac6f",
"CreationDate": 1695114697,
"ResultCode": "000000",
"ResultMessage": "Success",
"Status": "SUCCEEDED",
"ExecutionDate": 1695114698,
"Type": "PAYIN",
"Nature": "REGULAR",
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Tag": "Created using Mangopay API Postman Collection"
}
This endpoint allows you to capture the preauthorized funds without closing the preauthorization deposit object. It can be used prior to capturing additional funds with the Create a Deposit Preauthorized PayIn complement endpoint.
Note – Pay-in prior to complement must be full capture
The pay-in requested on this endpoint (prior to complement) must be a full capture of the preauthorized amount - it can’t be partial.
Body parameters
The unique identifier of the user at the source of the transaction.
The unique identifier of the credited wallet.
Information about the debited funds.
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the fees.
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The unique identifier of the deposit preauthorization.
Max. length: 255 characters
Custom data that you can add to this object.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
Responses
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
The unique identifier of the credited wallet.
The unique identifier of the deposit preauthorization.
The unique identifier of the object.
The date and time at which the object was created.
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.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT
The nature of the transaction, providing more information about the context in which the transaction occurred:
REGULAR– Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.REPUDIATION– Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).REFUND– Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).SETTLEMENT– Transfer made to the repudiation wallet by the platform to settle a lost dispute.
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
Information about the debited funds.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the fees.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Max. length: 10 characters; only alphanumeric and spaces
Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "c15a0451-5f23-46b9-b6ec-74f3a74f18c6",
"Date": 1699263395,
"errors": {
"DebitedFunds": "The value should be equal to 20000"
}
}
{
"Message": "The deposit is not in the PreAuthorized status.",
"Type": "invalid_action",
"Id": "bc763733-37ca-4eb9-88bb-0829194652db",
"Date": 1695118133,
"errors": null
}
{
"AuthorId": "203063430",
"CreditedUserId": "203063430",
"CreditedWalletId": "203063456",
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Id": "265d22b6-a3dc-48a4-a685-8655e5bcac6f",
"CreationDate": 1695114697,
"ResultCode": "000000",
"ResultMessage": "Success",
"Status": "SUCCEEDED",
"ExecutionDate": 1695114698,
"Type": "PAYIN",
"Nature": "REGULAR",
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Tag": "Created using Mangopay API Postman Collection"
}
{
"AuthorId": "203063430",
"CreditedWalletId": "203063456",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Tag": "Created using Mangopay API Postman Collection"
}
{
"AuthorId": "203063430",
"CreditedWalletId": "203063456",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Tag": "Created using Mangopay API Postman Collection"
}
{
"AuthorId": "203063430",
"CreditedUserId": "203063430",
"CreditedWalletId": "203063456",
"DepositId": "09d21294-f9ac-4797-b2b9-8cc7b4f05f1d",
"Id": "265d22b6-a3dc-48a4-a685-8655e5bcac6f",
"CreationDate": 1695114697,
"ResultCode": "000000",
"ResultMessage": "Success",
"Status": "SUCCEEDED",
"ExecutionDate": 1695114698,
"Type": "PAYIN",
"Nature": "REGULAR",
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Tag": "Created using Mangopay API Postman Collection"
}