Retrieve a balance transaction

Retrieves a balance transaction with a specified identifier.

Important: This operation is experimental and may change.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Balance transaction retrieved.

Response Schema: application/json
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 Self (object) or ParentLink (object) or TransactionLink (object) (Self) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
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.

404

Resource not found.

get/balance-transactions/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "charge",
  • "parentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "transactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ],
  • "_embedded": [
    ]
}