Overview
User management
User verification
Wallets
Cards
Card pay-ins
Banking pay-ins
APM pay-ins
Transfers
Refunds
Disputes
Payouts
FX conversions
Transactions
- The Transaction object
- GETList Transactions for a User
- GETList Transactions for a Wallet
- GETList Transactions for a Client Wallet
- GETList Transactions for a Card
- GETList Transactions for a Card Fingerprint
- GETList Transactions for a Preauthorization
- GETList Transactions for a Deposit Preauthorization
- GETList Transactions for a Bank Account
- GETList Transactions for a Mandate
- GETList Transactions for a Dispute
Echo
Helpers
Platform account
Copy
[
{
"Id": "1d703749-8b07-4d82-8473-528e9b0322cc",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1721742582,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742583,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
},
{
"Id": "05cb5843-1207-4382-aa04-25b5dc994847",
"Tag": "Created using the Mangopay API Collection postman",
"CreationDate": 1721742590,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 9000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742591,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
}
]
Transactions
List Transactions for a Deposit Preauthorization
GET
/
v2.01
/
{ClientId}
/
deposit-preauthorizations
/
{DepositId}
/
transactions
Copy
[
{
"Id": "1d703749-8b07-4d82-8473-528e9b0322cc",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1721742582,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742583,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
},
{
"Id": "05cb5843-1207-4382-aa04-25b5dc994847",
"Tag": "Created using the Mangopay API Collection postman",
"CreationDate": 1721742590,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 9000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742591,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
}
]
This call returns all preauthorized pay-ins, both captures and complements, made against a given 30-day preauthorization, whether they were successful or not.
Path parameters
The unique identifier of the deposit preauthorization.
Query parameters
Allowed values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction. You can filter on multiple values by separating them with a comma.The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.
The date before which the transaction was created (based on the transaction’s
CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.The date after which the transaction was created (based on the transaction’s
CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.Responses
200
200
The list of transactions created by the platform.
Show properties
Show properties
The transaction created by the platform.
Show properties
Show properties
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom 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.
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 date and time at which the object was created.
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.
Show properties
Show properties
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 (the sell currency).
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).During a conversion, (DebitedFunds.Amount - Fees) * MarketRate = CreditedFunds.Amount. Information about the credited funds (
CreditedFunds = DebitedFunds - Fees).Show properties
Show properties
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).
Show properties
Show properties
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, FAILEDThe status of the transaction.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 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.The type of transaction.
Returned values:
REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
Copy
[
{
"Id": "1d703749-8b07-4d82-8473-528e9b0322cc",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1721742582,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 20000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 19000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742583,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
},
{
"Id": "05cb5843-1207-4382-aa04-25b5dc994847",
"Tag": "Created using the Mangopay API Collection postman",
"CreationDate": 1721742590,
"AuthorId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"CreditedUserId": "user_m_01J18HZSACR1EMYNY1TBS8KTJD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 9000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1721742591,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
"DebitedWalletId": null,
"DepositId": "deposit_m_01J3FXN0PAAYJCYMWMM8DRGY5A"
}
]
Was this page helpful?
⌘I