List Transactions for a Deposit Preauthorization

GET /v2.01/{ClientId}/deposit-preauthorizations/{DepositId}/transactions

200

[
    {
        "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

DepositId · string · required

The unique identifier of the deposit preauthorization.

Query parameters

Status · string

Allowed values: CREATED, SUCCEEDED, FAILED

The status of the transaction. You can filter on multiple values by separating them with a comma.

ResultCode · string

The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.

BeforeDate · Unix timestamp

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.

AfterDate · Unix timestamp

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

Array (Transactions) · array

The list of transactions created by the platform.

Show properties

Object (transaction) · object

The transaction created by the platform.

Show properties

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

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.

CreationDate · Unix timestamp

The date and time at which the object was created.

AuthorId · string

The unique identifier of the user at the source of the transaction.

CreditedUserId · string

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

DebitedFunds · object

Information about the debited funds.

Show properties

Currency · string

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).

Amount · integer

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. 

CreditedFunds · object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency · string

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.

Amount · integer

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).

Fees · object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency · string

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.

Amount · integer

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).

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode · string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage · string

The explanation of the result code.

ExecutionDate · Unix timestamp

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.

Type · string

The type of transaction.

Nature · string

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.

CreditedWalletId · string

The unique identifier of the credited wallet.

DebitedWalletId · string

The unique identifier of the debited wallet.

200

[
    {
        "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"
    }
]