> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mangopay.com/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server. # 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** > > **Note – `DebitedBankAccount` only available for EU IBAN** > > The `DebitedBankAccount` information may not be available for pay-ins made from non-EU IBANs. ### Attributes The External Instruction Bank Wire PayIn object can be retrieved from the [GET View a PayIn](/api-reference/pay-ins/view-payin) endpoint. ### Schema (`ExternalInstructionPayInResponse`) ```yaml components: schemas: Id: type: string description: >- Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. title: Id Tag: type: string description: >- Max. length: 255 characters Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: `"{\"id_1\":AB123,\"id_2\":DE456}"`. title: Tag CreationDate: type: integer description: Unix timestamp (UTC) of the date and time the object was created. title: CreationDate ResultCode: type: string description: >- The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. title: ResultCode ResultMessage: type: string description: The explanation of the result code. title: ResultMessage AuthorId: type: string description: The unique identifier of the user at the source of the transaction. title: AuthorId CreditedUserId: type: string description: >- **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited. title: CreditedUserId Currency: type: string description: >- **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 amount. title: Currency Amount: type: integer description: >- The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. title: Amount ExternalInstructionPayInResponseDebitedFunds: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: Information about the debited funds. title: ExternalInstructionPayInResponseDebitedFunds ExternalInstructionPayInResponseCreditedFunds: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: >- Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). title: ExternalInstructionPayInResponseCreditedFunds ExternalInstructionPayInResponseFees: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: >- Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). title: ExternalInstructionPayInResponseFees TransactionStatus: type: string description: |- **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the transaction. title: TransactionStatus TransactionExecutionDate: type: integer description: >- 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`. title: TransactionExecutionDate TransactionType: type: string description: |- **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT` The type of the transaction. title: TransactionType TransactionNature: type: string description: >- **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. title: TransactionNature ExternalInstructionPayInResponseDebitedBankAccount: type: object properties: Type: type: string description: |- **Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER` The type of the bank account. OwnerName: type: string description: >- Max. length: 255 characters The full name of the owner of the bank account. (Format: FirstName LastName) IBAN: type: string description: >- 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: type: string description: >- 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: type: string description: The unique number of the bank account. Country: type: string description: >- Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country in which the bank account is registered. description: |- Information about the debited bank account. **Note:** This information may only be available for EU IBANs. title: ExternalInstructionPayInResponseDebitedBankAccount ExternalInstructionPayInResponse: type: object properties: Id: $ref: '#/components/schemas/Id' Tag: $ref: '#/components/schemas/Tag' CreationDate: $ref: '#/components/schemas/CreationDate' ResultCode: $ref: '#/components/schemas/ResultCode' ResultMessage: $ref: '#/components/schemas/ResultMessage' AuthorId: $ref: '#/components/schemas/AuthorId' CreditedUserId: $ref: '#/components/schemas/CreditedUserId' DebitedFunds: $ref: '#/components/schemas/ExternalInstructionPayInResponseDebitedFunds' description: Information about the debited funds. CreditedFunds: $ref: '#/components/schemas/ExternalInstructionPayInResponseCreditedFunds' description: >- Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). Fees: $ref: '#/components/schemas/ExternalInstructionPayInResponseFees' description: >- Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). Status: $ref: '#/components/schemas/TransactionStatus' ExecutionDate: $ref: '#/components/schemas/TransactionExecutionDate' Type: $ref: '#/components/schemas/TransactionType' Nature: $ref: '#/components/schemas/TransactionNature' CreditedWalletId: type: string description: The unique identifier of the credited wallet. DebitedWalletId: type: string description: >- 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. PaymentType: type: string description: |- **Returned values:** `BANK_WIRE` The payment type of the pay-in. ExecutionType: type: string description: |- **Returned values:** `EXTERNAL_INSTRUCTION` The execution type of the pay-in. WireReference: type: string description: >- 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`. BankingAliasId: type: string description: The unique identifier of the banking alias. DebitedBankAccount: $ref: >- #/components/schemas/ExternalInstructionPayInResponseDebitedBankAccount description: |- Information about the debited bank account. **Note:** This information may only be available for EU IBANs. title: ExternalInstructionPayInResponse ```