View a PayIn (External Instruction)
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
200 - Response parameters
200 - Response parameters
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
The unique identifier of the user at the source of the transaction.
The unique identifier of the credited wallet.
Information about the debited bank account.
Note: This information may only be available for EU IBANs.
The unique identifier of the banking alias.
Returned values: PAYIN
, TRANSFER
, CONVERSION
, PAYOUT
The type of the transaction.
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.
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 date and time at which the object was created.
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 reference of the bank wire received on the virtual IBAN, as provided by the user. If no reference was provided, then this value is null
.
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 debited wallet.
In the case of a pay-in, this value is always null
since there is no debited wallet.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Information about the debited funds.
Information about the credited funds (CreditedFunds
= DebitedFunds
- Fees
).
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.