> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/guides/payment-methods/banking/bank-wire) **→**

### Attributes

<ParamField body="Id" type="string">
  The unique identifier of the object.
</ParamField>

<ParamField body="Tag" type="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.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

<ParamField body="ResultCode" type="string">
  The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
</ParamField>

<ParamField body="ResultMessage" type="string">
  The explanation of the result code.
</ParamField>

<ParamField body="AuthorId" type="string">
  The unique identifier of the user at the source of the transaction.
</ParamField>

<ParamField body="CreditedUserId" type="string">
  **Default value:** The unique identifier of the owner of the credited wallet.

  The unique identifier of the user whose wallet is credited.
</ParamField>

<ParamField body="DebitedFunds" type="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`.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the debited funds.
    </ParamField>

    <ParamField body="Amount" type="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`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="CreditedFunds" type="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`.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the credited funds.
    </ParamField>

    <ParamField body="Amount" type="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`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="Fees" type="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`.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the fees.
    </ParamField>

    <ParamField body="Amount" type="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`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="Status" type="string">
  **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`

  The status of the transaction.
</ParamField>

<ParamField body="ExecutionDate" type="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`.
</ParamField>

<ParamField body="Type" type="string">
  **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`

  The type of the transaction.
</ParamField>

<ParamField body="Nature" type="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.
</ParamField>

<ParamField body="CreditedWalletId" type="string">
  The unique identifier of the credited wallet.
</ParamField>

<ParamField body="PaymentType" type="string">
  **Returned values:** `CARD`, `DIRECT_DEBIT`, `PREAUTHORIZED`, `BANK_WIRE`

  The type of pay-in.
</ParamField>

<ParamField body="ExecutionType" type="string">
  **Returned values:** `WEB`, `DIRECT`, `EXTERNAL_INSTRUCTION`

  The type of execution for the pay-in.
</ParamField>

<ParamField body="DeclaredDebitedFunds" type="object">
  Information about the declared funds to be wired by the end user to the returned bank account.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the funds.
    </ParamField>

    <ParamField body="Amount" type="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`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="DeclaredFees" type="object">
  Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the fees.
    </ParamField>

    <ParamField body="Amount" type="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`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="WireReference" type="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.
</ParamField>

<ParamField body="BankAccount" type="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.

  <Expandable title="properties">
    <ParamField body="OwnerAddress" type="object">
      Information about the address of residence of the bank account owner.

      <Expandable title="properties">
        <ParamField body="AddressLine1" type="string">
          Max. length: 255 characters

          The first line of the address.
        </ParamField>

        <ParamField body="AddressLine2" type="string">
          Max. length: 255 characters

          The second line of the address.
        </ParamField>

        <ParamField body="City" type="string">
          Max. length: 255 characters

          The city of the address.
        </ParamField>

        <ParamField body="Region" type="string">
          Max. length: 255 characters

          Required if `Country` is US, CA, or MX.

          The region of the address.
        </ParamField>

        <ParamField body="PostalCode" type="string">
          Max. length: 255 characters

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

        <ParamField body="Country" type="string">
          Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))

          The country of the address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="Type" type="string">
      **Returned values:** `IBAN`, `US`, `CA`, `GB`, `OTHER`

      The type of the bank account.
    </ParamField>

    <ParamField body="OwnerName" type="string">
      Max. length: 255 characters

      The full name of the owner of the bank account.
    </ParamField>

    <ParamField body="IBAN" type="string">
      The IBAN (international bank account number) for the bank account.
    </ParamField>

    <ParamField body="BIC" type="string">
      The BIC (international identifier of the bank) for the bank account.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="ProfilingAttemptReference" type="string">
  The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
</ParamField>

<ResponseField name="TransactionDetails" type="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.

  <Expandable title="properties">
    <ResponseField name="BankTransactionDomainCode" type="string">
      Max. length: 50 characters

      The bank transaction domain code (e.g. PMNT).
    </ResponseField>

    <ResponseField name="BankTransactionDomainFamilyCode" type="string">
      Max. length: 50 characters

      The bank transaction domain family code (e.g. ICDT).
    </ResponseField>

    <ResponseField name="BankTransactionDomainSubFamilyCode" type="string">
      Max. length: 50 characters

      The domain sub-family code (e.g. ACDT).
    </ResponseField>

    <ResponseField name="References" type="array (object)">
      References for the transaction. If multiple references are available, multiple objects are returned.

      <Expandable title="properties">
        <ResponseField name="Type" type="string">
          Max. length: 50 characters

          The type of the reference.
        </ResponseField>

        <ResponseField name="Value" type="string">
          Max. length: 100 characters

          The value of the reference.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="DebtorName" type="string">
      Max. length: 100 characters

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

    <ResponseField name="DebtorAccount" type="string">
      Max. length: 50 characters

      The account identifier of the debtor (e.g. the account number).
    </ResponseField>

    <ResponseField name="DebtorAgent" type="string">
      Max. length: 50 characters

      The agent of the debtor (e.g. the BIC or bank code).
    </ResponseField>

    <ResponseField name="DebtorAddressLine1" type="string">
      Max. length: 500 characters

      The first line of the debtor’s address.
    </ResponseField>

    <ResponseField name="DebtorAddressLine2" type="string">
      Max. length: 500 characters

      The second line of the debtor’s address.
    </ResponseField>

    <ResponseField name="DebtorAddressLine3" type="string">
      Max. length: 500 characters

      The third line of the debtor’s address.
    </ResponseField>

    <ResponseField name="RemittanceInformationLine1" type="string">
      Max. length: 1,000 characters

      Remittance information for the transaction.
    </ResponseField>

    <ResponseField name="RemittanceInformationLine2" type="string">
      Max. length: 1,000 characters

      Remittance information for the transaction.
    </ResponseField>

    <ResponseField name="RemittanceInformationLine3" type="string">
      Max. length: 1,000 characters

      Remittance information for the transaction.
    </ResponseField>

    <ResponseField name="RemittanceInformationLine4" type="string">
      Max. length: 1,000 characters

      Remittance information for the transaction.
    </ResponseField>
  </Expandable>
</ResponseField>

### Related resources

<CardGroup col={1}>
  <Card title="Guide" href="/guides/payment-methods/banking/bank-wire">
    Learn more about bank wire pay-ins
  </Card>
</CardGroup>