> ## Documentation Index
> Fetch the complete documentation index at: https://doc-test-my.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Transfers Entity

> Know about transfers entity parameters and their description.

The transfers entity has the following parameters.

<ResponseExample>
  ```json Entity theme={null}
  {
    "entity":"collection",
    "count":2,
    "items":[
      {
        "id":"trf_ECB6hP5cyN30pU",
        "entity":"transfer",
        "transfer_status":"failed",
        "settlement_status":null,
        "source":"pay_EB1R2s8D4vOAKG",
        "recipient":"acc_CNo3jSI8OkFJJJ",
        "amount":100,
        "currency":"INR",
        "amount_reversed":0,
        "notes":{
          "name":"Saurav Kumar",
          "roll_no":"IEC2011026"
        },
        "error":{
          "code":"BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
          "description":"Transfer failed due to insufficient balance",
          "field":null,
          "source":"transfer",
          "step":"balance_check",
          "reason":"insufficient_balance"
        },
        "fees":1,
        "tax":0,
        "on_hold":false,
        "on_hold_until":null,
        "recipient_settlement_id":null,
        "created_at":1580712811,
        "linked_account_notes":[
          "roll_no"
        ],
        "processed_at":1580712811
      },
      {
        "id":"trf_ECB6hP5cyN30pU",
        "entity":"transfer",
        "transfer_status":"failed",
        "settlement_status":null,
        "source":"pay_EB1R2s8D4vOAKG",
        "recipient":"acc_CNo3jSI8OkFJJJ",
        "amount":100,
        "currency":"INR",
        "amount_reversed":0,
        "notes":{
          "name":"Saurav Kumar",
          "roll_no":"IEC2011026"
        },
        "error":{
          "code":"BAD_REQUEST_PAYMENT_FEES_GREATER_THAN_AMOUNT",
          "description":"Transfer amount was greater than amount available for transfer",
          "field":null,
          "source":"transfer",
          "step":"amount_validation",
          "reason":"transfer_amount_higher_than_balance"
        },
        "fees":1,
        "tax":0,
        "on_hold":false,
        "on_hold_until":null,
        "recipient_settlement_id":null,
        "created_at":1580712811,
        "linked_account_notes":[
          "roll_no"
        ],
        "processed_at":1580712811
      }
    ]
  }
  ```

  ```json Entity theme={null}
  {
    "entity":"collection",
    "count":2,
    "items":[
      {
        "id":"trf_ECB6hP5cyN30pU",
        "entity":"transfer",
        "transfer_status":"failed",
        "settlement_status":null,
        "source":"pay_EB1R2s8D4vOAKG",
        "recipient":"acc_CNo3jSI8OkFJJJ",
        "amount":100,
        "currency":"MYR",
        "amount_reversed":0,
        "notes":{
          "name":"Nur Aisyah",
          "roll_no":"IEC2011026"
        },
        "error":{
          "code":"BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
          "description":"Transfer failed due to insufficient balance",
          "field":null,
          "source":"transfer",
          "step":"balance_check",
          "reason":"insufficient_balance"
        },
        "fees":1,
        "tax":0,
        "on_hold":false,
        "on_hold_until":null,
        "recipient_settlement_id":null,
        "created_at":1580712811,
        "linked_account_notes":[
          "roll_no"
        ],
        "processed_at":1580712811
      },
      {
        "id":"trf_ECB6hP5cyN30pU",
        "entity":"transfer",
        "transfer_status":"failed",
        "settlement_status":null,
        "source":"pay_EB1R2s8D4vOAKG",
        "recipient":"acc_CNo3jSI8OkFJJJ",
        "amount":100,
        "currency":"MYR",
        "amount_reversed":0,
        "notes":{
          "name":"Siti Aisyah",
          "roll_no":"IEC2011026"
        },
        "error":{
          "code":"BAD_REQUEST_PAYMENT_FEES_GREATER_THAN_AMOUNT",
          "description":"Transfer amount was greater than amount available for transfer",
          "field":null,
          "source":"transfer",
          "step":"amount_validation",
          "reason":"transfer_amount_higher_than_balance"
        },
        "fees":1,
        "tax":0,
        "on_hold":false,
        "on_hold_until":null,
        "recipient_settlement_id":null,
        "created_at":1580712811,
        "linked_account_notes":[
          "roll_no"
        ],
        "processed_at":1580712811
      }
    ]
  }
  ```
</ResponseExample>

<ResponseField name="id" type="string">
  Unique identifier of the transfer.
</ResponseField>

<ResponseField name="entity" type="string">
  The name of the entity. Here, it is `transfer`.
</ResponseField>

<ResponseField name="transfer_status" type="string">
  The status of the transfer. Possible values are:

  * `created`
  * `pending`
  * `processed`
  * `failed`
  * `reversed`
  * `partially_reversed`
</ResponseField>

<ResponseField name="settlement_status" type="string">
  The status of the settlement. Possible values are:

  * `pending`
  * `on_hold`
  * `settled`
</ResponseField>

<ResponseField name="source" type="string">
  Unique identifier of the transfer source. The source can be a `payment` or an `order`.
</ResponseField>

<ResponseField name="recipient" type="string">
  Unique identifier of the transfer destination, that is, the Linked Account.
</ResponseField>

<ResponseField name="amount" type="integer">
  The amount to be transferred to the Linked Account, in sen. For example, for an amount of RM200.35, the value of this field should be 20035.
</ResponseField>

<ResponseField name="currency" type="string">
  ISO currency code. We support route transfers only in `MYR`.
</ResponseField>

<ResponseField name="amount_reversed" type="integer">
  Amount reversed from this transfer for refunds.
</ResponseField>

<ResponseField name="notes" type="json object">
  Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.
</ResponseField>

<ResponseField name="error" type="string">
  Provides error details that may occur during transfers.
</ResponseField>

<ResponseField name="code" type="string">
  Type of the error.
</ResponseField>

<ResponseField name="description" type="string">
  Error description.
</ResponseField>

<ResponseField name="field" type="string">
  Name of the parameter in the API request that caused the error.
</ResponseField>

<ResponseField name="source" type="string">
  The point of failure in the specific operation. For example, customer, business and so on.
</ResponseField>

<ResponseField name="step" type="string">
  The stage where the transaction failure occurred. Stages can be different depending on the payment method used to make the transaction.
</ResponseField>

<ResponseField name="id" type="string">
  Unique identifier of the transfer.
</ResponseField>

<ResponseField name="reason" type="string">
  The exact error reason. It can be handled programmatically.
</ResponseField>

<ResponseField name="linked_account_notes" type="array">
  List of keys from the `notes` object which needs to be shown to Linked Accounts on their Dashboard. For example, `"region", "city"`. Only the keys will be shown, not values.
</ResponseField>

<ResponseField name="on_hold" type="boolean">
  Indicates whether the account settlement for transfer is on hold. Possible values:

  * `true`: Puts the settlement on hold.
  * `false`: Releases the settlement.
</ResponseField>

<ResponseField name="on_hold_until" type="integer">
  Timestamp, in Unix format, indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.
</ResponseField>

<ResponseField name="recipient_settlement_id" type="string">
  Unique identifier of the settlement.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Timestamp, in Unix, at which the record was created.
</ResponseField>