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
- 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
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
View a PayIn (Bank Wire)
Note – Pay-in data retained for 13 months
An API call to retrieve a pay-in whose CreationDate
is older than 13 months may return 404 Not Found.
For more information, see the Data availability periods article.
Path parameters
The unique identifier of the pay-in.
Responses
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).
For a direct bank wire pay-in, the Fees
displays placeholder values (currency XXX and amount 0) until the Status
changes to SUCCEEDED.
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.
Information about the declared funds to be wired by the end user to the returned bank account.
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 to be 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
).
Max. length: 255 characters
The reference which the end user must provide when making the bank wire. The WireReference
is used to reconcile the funds that arrive on the bank account with the DeclaredDebitedFunds
in the Direct Bank Wire PayIn object.
Caution: This reference is specific to each payment and must be retrieved dynamically.
Information about the bank account to which the bank wire must be made by the end user.
Caution: Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice.
Information about the address of residence of the bank account owner.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country
is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Returned values: IBAN
, US
, CA
, GB
, OTHER
The type of the bank account.
Max. length: 255 characters
The full name of the owner of the bank account.
The IBAN (international bank account number) for the bank account.
The BIC (international identifier of the bank) for the bank account.
Was this page helpful?