/
Retrieve balance transact...

Retrieve balance transactions
Experimental

Request

Retrieves a list of balance transactions.

Important: This operation is experimental and may change.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/balance-transactions?limit=0&offset=0&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of balance transactions retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the balance transaction.

Example:"btxn_0YVCNJYRXTDDQ9QF2Z60ZA05WP"
typestringrequired

Type of balance transaction.

Value:"charge"
Discriminator
parentIdstring or null, <= 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.

Example:"btxn_0YVCNJYRXTDDQ9QF2Z60ZA05WP"
transactionIdstring, <= 50 characters(TransactionId)

ID of the related transaction.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
settlementCurrencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
settlementAmountnumber or null, (double)

Amount of the settlement.

settlementTimestring, (date-time)(ServerTimestamp)read-only

Date and time of the expected settlement.

settlementRatenumber or null, (double)

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

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "btxn_0YVCNJYRXTDDQ9QF2Z60ZA05WP",
    "type": "charge",
    "parentId": "btxn_0YVCNJYRXTDDQ9QF2Z60ZA05WP",
    "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
    "settlementCurrency": "USD",
    "settlementAmount": 0,
    "settlementTime": "2019-08-24T14:15:22Z",
    "settlementRate": 0,
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]