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.

Learn more →

Attributes

Id · string

The unique identifier of the object.

Tag · string

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.

CreationDate · Unix timestamp

The date and time at which the object was created.

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.

AuthorId · string

The unique identifier of the user at the source of the transaction.

CreditedUserId · string

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

DebitedFunds · object

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.

Show properties

Currency · string

Returned 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 debited funds.

Amount · integer

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).

CreditedFunds · object

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.

Show properties

Currency · string

Returned 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.

Amount · integer

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).

Fees · object

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.

Show properties

Currency · string

Returned 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.

Amount · integer

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).

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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.

Type · string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature · string

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.

CreditedWalletId · string

The unique identifier of the credited wallet.

PaymentType · string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE

The type of pay-in.

ExecutionType · string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

DeclaredDebitedFunds · object

Information about the declared funds to be wired by the end user to the returned bank account.

Show properties

Currency · string

Returned 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.

Amount · integer

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).

DeclaredFees · object

Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency · string

Returned 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.

Amount · integer

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).

WireReference · string

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.

BankAccount · object

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.

Show properties

OwnerAddress · object

Information about the address of residence of the bank account owner.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

Required if Country is US, CA, or MX.

The region of the address.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

Type · string

Returned values: IBAN, US, CA, GB, OTHER

The type of the bank account.

OwnerName · string

Max. length: 255 characters

The full name of the owner of the bank account.

IBAN · string

The IBAN (international bank account number) for the bank account.

BIC · string

The BIC (international identifier of the bank) for the bank account.

ProfilingAttemptReference · string

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.

TransactionDetails · array (object)

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.

Show properties

BankTransactionDomainCode · string

Max. length: 50 characters

The bank transaction domain code (e.g. PMNT).

BankTransactionDomainFamilyCode · string

Max. length: 50 characters

The bank transaction domain family code (e.g. ICDT).

BankTransactionDomainSubFamilyCode · string

Max. length: 50 characters

The domain sub-family code (e.g. ACDT).

References · array (object)

References for the transaction. If multiple references are available, multiple objects are returned.

Show properties

Type · string

Max. length: 50 characters

The type of the reference.

Value · string

Max. length: 100 characters

The value of the reference.

DebtorName · string

Max. length: 100 characters

The name of the debtor (i.e. the registered owner of the account that was debited).

DebtorAccount · string

Max. length: 50 characters

The account identifier of the debtor (e.g. the account number).

DebtorAgent · string

Max. length: 50 characters

The agent of the debtor (e.g. the BIC or bank code).

DebtorAddressLine1 · string

Max. length: 500 characters

The first line of the debtor’s address.

DebtorAddressLine2 · string

Max. length: 500 characters

The second line of the debtor’s address.

DebtorAddressLine3 · string

Max. length: 500 characters

The third line of the debtor’s address.

RemittanceInformationLine1 · string

Max. length: 1,000 characters

Remittance information for the transaction.

RemittanceInformationLine2 · string

Max. length: 1,000 characters

Remittance information for the transaction.

RemittanceInformationLine3 · string

Max. length: 1,000 characters

Remittance information for the transaction.

RemittanceInformationLine4 · string

Max. length: 1,000 characters

Remittance information for the transaction.

Related resources

Guide

Learn more about bank wire pay-ins