​
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 IBANThe DebitedBankAccount information may not be available for pay-ins made from non-EU IBANs.

​
Attributes

​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
DebitedBankAccount
object
Information about the debited bank account.Note: This information may only be available for EU IBANs.
​
BankingAliasId
string
The unique identifier of the banking alias.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe 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.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
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.
​
WireReference
string
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.
​
PaymentType
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
DebitedWalletId
string
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.
​
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.