The External Instruction Bank Wire PayIn object
Description
The External Instruction Bank Wire PayIn object represents a wire transfer made directly from the end user’s bank account to a Virtual Account (or a legacy Banking Alias).
When the funds are received, Mangopay creates the pay-in and credits the associated wallet. This pay-in is therefore not created by the platform via the API, but rather created by Mangopay when it receives the bank wire transfer initiated by the end user.
It is not possible to specify Fees on these pay-ins.
Note – DebitedBankAccount only available for EU IBAN
The DebitedBankAccount information may not be available for pay-ins made from non-EU IBANs.
Attributes
The External Instruction Bank Wire PayIn object can be retrieved from the GET View a PayIn endpoint.
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.
Unix timestamp (UTC) of the date and time the object was created.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
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 credited funds (CreditedFunds = DebitedFunds - Fees).
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
Unix timestamp (UTC) of the date and time 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.
In the case of a pay-in, this value is always null since there is no debited wallet.
Returned values: BANK_WIRE
The payment type of the pay-in.
Returned values: EXTERNAL_INSTRUCTION
The execution type of the pay-in.
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.
Information about the debited bank account.
Note: This information may only be available for EU IBANs.