List Internal Transactions

GET 
/internal_transactions

List internal transactions performed on the authorized object (Entity or Platform).

The meta will always have total_count set to null since this API is an infinite scroll API.

Request

Query Parameters

page int32

Default value: 1

Page to list

id uuid

Internal Transaction ID to look for

currency uuid

Filter transactions by currency

created_at[gt] timestamp

Filter settlements created on a date equal or greater than a give date

created_at[lt] timestamp

Filter settlements created on a date equal or less than a give date

updated_at[gt] timestamp

Filter settlements updated on a date equal or greater than a give date

updated_at[lt] timestamp

Filter settlements updated on a date equal or less than a give date

settled_at[gt] timestamp

Filter settlements settled on a date equal or greater than a give date

settled_at[lt] timestamp

Filter settlements settled on a date equal or less than a give date

Responses

200

Successful operation

application/json

Schema

Schema

internal_transactions

object[]

Array [

id uuid

recipient_type string

Possible values: [Entity, Platform, Beneficiary]

recipient_id uuid

currency Currency (string)

ISO-4217 three-letter currency code.

amount integer

Amount of the internal transaction movement.

transfer_id uuid

In case this internal transaction has been settled, this will contain the ID of the transaction.

description string

A string descriping the purpose of this internal transactions.

created_at timestamp

Date and time when the internal transaction was created.

updated_at timestamp

Date and time when the internal transaction status was updated.

settled_at timestamp

Date and time when the internal transaction was settled.

metadata

object

A set of key-value pairs where both key and value are strings. Metadata allows you to add more information to the object that will be returned later on in responses and webhook messages.

Metadata is searchable using the Payment List API.

property name* string

]

meta

object

current_page integer

next_page integer

prev_page integer

total_pages integer

total_count integer

Example (from schema)

{
  "internal_transactions": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recipient_type": "Entity",
      "recipient_id": "c5c57597-0d06-4583-9da5-c755c4943ede",
      "currency": "SAR",
      "amount": 24209,
      "transfer_id": "6db14dc8-9647-4dff-ae6f-822c29ae3a92",
      "description": "string",
      "created_at": "2026-02-15T12:59:11Z",
      "updated_at": "2026-02-15T12:59:11Z",
      "settled_at": "2026-02-16T10:13:12Z",
      "metadata": {
        "cart_id": "72e470a5-cbc4-47b3-a52a-e89fda6adb19",
        "customer_email": "[email protected]",
        "customer_id": "23432"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

Loading...