logo

Retrieve balance transactions

Retrieves a list of balance transactions.

Important: This operation is experimental and may change.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

List of balance transactions retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

ID of the balance transaction.

type
string

Type of balance transaction.

parentId
string <= 50 characters

ID of the parent entry if one exists.

Some types of transactions relate to parent transactions. For example, a risk-reserve relates to a charge, and a risk-reserve-release relates a to risk-reserve.

transactionId
string <= 50 characters

ID of the related transaction.

settlementCurrency
string = 3 characters

Currency code in ISO 4217 format.

settlementAmount
number <double>

Amount of the settlement.

settlementTime
string <date-time>

Date and time of the expected settlement.

settlementRate
number <double>

If the settlement currency does not match the transaction currency. This field displays the exchange rate of the settlement.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "parent" "transaction"
Array of BalanceTransactionEmbed (object) or TransactionEmbed (object)

Embedded objects that are requested by the expand query parameter.

Array
Any of:

Balance transaction.

object (Balance transaction)
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/balance-transactions
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Retrieve a balance transaction