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
The unique identifier of the object.
Max. length: 255 characters
Custom 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.
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.
Best practice: When the payout author is different from the bank account owner, the Payout AuthorId value must be different from the Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.
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. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
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.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Returned values: CREATED, SUCCEEDED, FAILED
The 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, PAYOUT
The type of the transaction.
Allowed values: REGULAR, REPUDIATION, REFUND, SETTLEMENT
The transaction natures to be taken into account.
- 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 (in the buy currency).
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.
Information about the declared funds to be wired by the end user to the returned bank account.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
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.
properties
Information about the address of residence of the bank account owner.
properties
Max. length: 255 characters The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
The country of the address.
Returned values: IBAN, US, CA, GB, OTHER
The type of the bank account.
Max. length: 255 characters The full name of the owner of the bank account.
The IBAN (international bank account number) for the bank account.
The BIC (international identifier of the bank) for the bank account.
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.
properties
Max. length: 50 characters
The bank transaction domain code (e.g. PMNT).
Max. length: 50 characters
The bank transaction domain family code (e.g. ICDT).
Max. length: 50 characters
The domain sub-family code (e.g. ACDT).
References for the transaction. If multiple references are available, multiple objects are returned.
properties
Max. length: 50 characters
The type of the reference.
Max. length: 100 characters
The value of the reference.
Max. length: 100 characters
The name of the debtor (i.e. the registered owner of the account that was debited).
Max. length: 50 characters
The account identifier of the debtor (e.g. the account number).
Max. length: 50 characters
The agent of the debtor (e.g. the BIC or bank code).
Max. length: 500 characters
The first line of the debtor’s address.
Max. length: 500 characters
The second line of the debtor’s address.
Max. length: 500 characters
The third line of the debtor’s address.
Max. length: 1,000 characters
Remittance information for the transaction.
Max. length: 1,000 characters
Remittance information for the transaction.
Max. length: 1,000 characters
Remittance information for the transaction.
Max. length: 1,000 characters
Remittance information for the transaction.