Bank wires
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 toSUCCEEDED and the wallet is credited.
The object expires 1 month after creation if no funds are received.
Learn more →
Attributes
The unique identifier of the object.
Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
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.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).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:
CREATED, SUCCEEDED, FAILEDThe 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, PAYOUTThe type of the transaction.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.
The unique identifier of the credited wallet.
Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.Information about the declared funds to be wired by the end user to the returned bank account.
Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Max. length: 255 charactersThe 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.
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.
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.