List Refunds for a PayIn
// GET has no body parameters
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]
Query parameters
Allowed values: CREATED, SUCCEEDED, FAILED
The 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.
Path parameters
The unique identifier of the pay-in.
Responses
200
200
The list of refunds created by the platform.
Show properties
Show properties
The refund 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 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 date and time at which the object was created.
The unique identifier of the user at the source of the initial transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Default value: The amount and currency values of the debited funds of the initial transaction.
Information about the debited funds. Debited funds:
- Takes by default the amount and currency values of the initial transaction when left empty.
- Must be entered manually to perform a partial refund.
- Cannot exceed the initial transaction
CreditedFundsvalue when entered manually. This also applies to the sum of debited funds when making multiple partial refunds.
Show properties
Show properties
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: 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.
Default value: The amount and currency values of the fees of the initial transaction.
Information about the fees. This value:
- Should be preceded by a minus sign (-) to refund the fees, otherwise more fees will be taken.
- Takes by default the amount and currency values of the fees of the initial transaction when left empty (preceded by a -).
- Cannot exceed the initial transaction fees amount when entered manually. This also applies to the sum of the amount of the fees when making multiple partial refunds.
Show properties
Show properties
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: 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.
Returned values: CREATED, SUCCEEDED, FAILED
The 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.
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 debited wallet.
The unique identifier of the credited wallet.
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]
// GET has no body parameters
Was this page helpful?
// GET has no body parameters
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]
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
List Refunds for a PayIn
// GET has no body parameters
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]
Query parameters
Allowed values: CREATED, SUCCEEDED, FAILED
The 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.
Path parameters
The unique identifier of the pay-in.
Responses
200
200
The list of refunds created by the platform.
Show properties
Show properties
The refund 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 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 date and time at which the object was created.
The unique identifier of the user at the source of the initial transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Default value: The amount and currency values of the debited funds of the initial transaction.
Information about the debited funds. Debited funds:
- Takes by default the amount and currency values of the initial transaction when left empty.
- Must be entered manually to perform a partial refund.
- Cannot exceed the initial transaction
CreditedFundsvalue when entered manually. This also applies to the sum of debited funds when making multiple partial refunds.
Show properties
Show properties
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: 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.
Default value: The amount and currency values of the fees of the initial transaction.
Information about the fees. This value:
- Should be preceded by a minus sign (-) to refund the fees, otherwise more fees will be taken.
- Takes by default the amount and currency values of the fees of the initial transaction when left empty (preceded by a -).
- Cannot exceed the initial transaction fees amount when entered manually. This also applies to the sum of the amount of the fees when making multiple partial refunds.
Show properties
Show properties
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: 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.
Returned values: CREATED, SUCCEEDED, FAILED
The 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.
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 debited wallet.
The unique identifier of the credited wallet.
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]
// GET has no body parameters
Was this page helpful?
// GET has no body parameters
[
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with fees refunded",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 3000
},
"Fees": {
"Currency": "EUR",
"Amount": -500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
},
{
"Id": "wt_498263ef-5a87-4ef9-a2ab-995748fc478a",
"Tag": "Partial refund with more fees taken",
"CreationDate": 1737388152,
"AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
"CreditedUserId": null,
"DebitedFunds": {
"Currency": "EUR",
"Amount": 2500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 2000
},
"Fees": {
"Currency": "EUR",
"Amount": 500
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1737388152,
"Type": "PAYOUT",
"Nature": "REFUND",
"InitialTransactionId": "wt_bbcb7335-d513-49f6-a86b-502de501d675",
"InitialTransactionType": "PAYIN",
"InitialTransactionNature": "REGULAR",
"DebitedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
"CreditedWalletId": null
}
]