The Bank Wire PayIn object
Description
The Direct Bank Wire PayIn object represents a declaration of funds to be wired by the end user to the returned bank account. When the funds are received on the bank account and reconciled (i.e., matched) with the declaration, the status is updated to SUCCEEDED and the wallet is credited.
The object expires 1 month after creation if no funds are received.
Attributes
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 Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).
If the FlowDescriptor.Beneficiaries is sent in the API request, then:
- The transaction’s
CreditedWalletIdholder is disregarded in KYC/KYB checks. - ALL
UserIdvalues in the array must be one of:OWNERwhoseKYCLevelisREGULARPLATFORM
The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:
PAYEROWNERwhoseKYCLevelisLIGHT
If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.
Information about the debited funds.
For a direct bank wire pay-in, the DebitedFunds displays placeholder values (currency XXX and amount 0) until the Status changes to SUCCEEDED.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
For a direct bank wire pay-in, the CreditedFunds displays placeholder values (currency XXX and amount 0) until the Status changes to SUCCEEDED.
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: DIRECT
The execution type of the pay-in.
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.
Max. length: 50 characters
Information received from banking partners for the transaction, based on the cash management (Camt) messages of ISO 20022.
This information is only returned when the pay-in Status becomes SUCCEEDED.
If data is not available then an empty array, null, or nulled fields are returned.
If multiple wire payments are received for a single pay-in, then multiple objects are returned.