The External Instruction Bank Wire PayIn object

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 IBAN

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

Show properties

IBAN · string

Max. length: 34 characters

The IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which:

• CC represents the country code (ISO 3166-1 alpha 2)
• DD represents two check digits used by banking systems to avoid simple errors
• BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.
  Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.

BIC · string

The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.

The BIC can have one of the two following formats:

• BIC8 – 8-character BIC (AAAABBCC)
• BIC11 – 11-character BIC (AAAABBCCDDD)

In which:

• AAAA represents the bank code: 4 characters defining the bank
• BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)
• CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country
• DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)

AccountNumber · string

The unique number of the bank account.

Country · string

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

The country in which the bank account is registered.

OwnerName · string

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Type · string

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

The type of the bank account.

BankingAliasId · string

The unique identifier of the banking alias.

Type · string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The 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, 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.

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_WIRE

The type of pay-in.

ExecutionType · string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

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

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

DebitedFunds · object

Information about the debited funds.

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

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

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.