/
Retrieve a balance transa...

Retrieve a balance transaction
Experimental

Request

Retrieves a balance transaction with a specified identifier.

Important: This operation is experimental and may change.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/balance-transactions/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Balance transaction retrieved.

Bodyapplication/json
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": [
    { … }
  ]
}