Internal Transfer

This resource represents internal fund movements between merchant accounts within the platform–partner model. Internal transfers enable seamless fund movement between merchants who operate under the same platform account. Internal transfers are restricted to accounts linked under the same platform hierarchy. The following transfer directions are supported:

Transfer Type	Description
P → C	From a Platform (P) account to one of its Child (C) merchant accounts.
C → P	From a Child (C) merchant account back to its Platform (P) account.
C → C (same P)	Between Child (C) accounts under the same Platform (P).

SchemasOperations

InternalTransfer

idstringread-only

The unique identifier for the internal transfer.

Example:"inttransfer_68f1f9126GDCB"

from_merchant_idstring

The unique identifier of the merchant account from which funds were transferred.

Example:"merch_68cc1216xPrdU"

to_merchant_idstring

The unique identifier of the merchant account to which funds were transferred.

Example:"merch_68cc0571y5S4h"

owner_merchant_idstring

The unique identifier of the merchant account that owns/initiated this transfer.

Example:"merch_68cc0571y5S4h"

transfer_amountinteger

The amount transferred in cents. For example, 1000 cents is 10.00.

Example:1000

transfer_currencystring, (iso-4217, case-insensitive)

The currency in which the transfer was made. The currency code is in ISO 4217 format.

Example:"AED"

referencestring

The reference identifier provided for the transfer.

Example:"123"

feesobject

The fees associated with the internal transfer.

Example:

{
  "txn_fee": {
    "currency": "AED",
    "amount": 0
  },
  "fx_fee": {
    "currency": "AED",
    "amount": 0
  }
}

error_codestring or nullread-only

The error code if the internal transfer failed, null otherwise.

Example:null

error_descriptionstring or nullread-only

The error description if the internal transfer failed, null otherwise.

Example:null

created_atstring, (date-time)read-only

The creation timestamp of the internal transfer.

Example:"2025-10-17T08:06:42Z"

updated_atstring, (date-time)read-only

The last update timestamp of the internal transfer.

Example:"2025-10-17T08:06:42Z"

{
  "id": "inttransfer_68f1f9126GDCB",
  "from_merchant_id": "merch_68cc1216xPrdU",
  "to_merchant_id": "merch_68cc0571y5S4h",
  "owner_merchant_id": "merch_68cc0571y5S4h",
  "transfer_amount": 1000,
  "transfer_currency": "AED",
  "reference": "123",
  "fees": {
    "txn_fee": { … },
    "fx_fee": { … }
  },
  "error_code": null,
  "error_description": null,
  "created_at": "2025-10-17T08:06:42Z",
  "updated_at": "2025-10-17T08:06:42Z"
}