Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- IDV sessions
- 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
- Bank wires
- Pay by bank
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- Bizum
- 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
- Recipients
- 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 Preauthorized PayIn
{
"CreditedWalletId": "204089031",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}
{
"Id": "payin_m_01HYG8DRT5FHT1FV44MV9KR1BS",
"Tag": null,
"CreationDate": 1716385145,
"ResultCode": "000000",
"ResultMessage": "Success",
"AuthorId": "user_m_01HSDQD2RPPQ8NMM36EDGYBMEY",
"CreditedUserId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1800
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"Status": "SUCCEEDED",
"ExecutionDate": 1716385146,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "204089031",
"DebitedWalletId": null,
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}
Body parameters
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.
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.
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 debited 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 taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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 credited wallet.
The unique identifier of the preauthorization.
Responses
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this 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.
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.
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 debited 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 credited 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 taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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).
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.
The unique identifier of the credited wallet.
The unique identifier of the debited wallet.
In the case of a pay-in, this value is always null since there is no debited wallet.
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.
The unique identifier of the preauthorization.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this 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.
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.
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 debited 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 credited 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 taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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).
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.
The unique identifier of the credited wallet.
The unique identifier of the debited wallet.
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.
The unique identifier of the preauthorization.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "b6a5ae0d-7dc9-479a-86bd-55b0d40dccec#1669116785",
"Date": 1669116786,
"errors": {
"Status": "The PreAuthorization Status value has to be up to SUCCEEDED"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "2a6b5503-551b-4a66-a7f4-3ae4d6efc91f",
"Date": 1716385561.0,
"errors": {
"PaymentStatus": "The PreAuthorization PaymentStatus value has to be WAITING"
}
}
{
"Id": "payin_m_01HYG8DRT5FHT1FV44MV9KR1BS",
"Tag": null,
"CreationDate": 1716385145,
"ResultCode": "000000",
"ResultMessage": "Success",
"AuthorId": "user_m_01HSDQD2RPPQ8NMM36EDGYBMEY",
"CreditedUserId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1800
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"Status": "SUCCEEDED",
"ExecutionDate": 1716385146,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "204089031",
"DebitedWalletId": null,
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}
{
"CreditedWalletId": "204089031",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}
Was this page helpful?
{
"CreditedWalletId": "204089031",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}
{
"Id": "payin_m_01HYG8DRT5FHT1FV44MV9KR1BS",
"Tag": null,
"CreationDate": 1716385145,
"ResultCode": "000000",
"ResultMessage": "Success",
"AuthorId": "user_m_01HSDQD2RPPQ8NMM36EDGYBMEY",
"CreditedUserId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1800
},
"Fees": {
"Currency": "EUR",
"Amount": 200
},
"Status": "SUCCEEDED",
"ExecutionDate": 1716385146,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "204089031",
"DebitedWalletId": null,
"PaymentType": "PREAUTHORIZED",
"ExecutionType": "DIRECT",
"PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
}