Balance transaction schema

Property Type Description
created_at
string date-time

Date that the transaction was created

amount
number double

Amount of the transaction, denominated in currency_code.

currency_code
string

Currency of the transaction amount and running balance. Always matches the organization's currency.

balance
number double

The updated total after the transaction, denominated in currency_code. Note that this running balance may be delayed and contain null.

action
string

The action that was performed

description
string

A brief description of the transaction

order
object

Order details

Show object properties
Property Type Description
id
string
external_id
string

Reference for this order, supplied by the customer.

When set, external_id makes order idempotent. All requests that use the same external_id

after the initial order creation, will result in a response that returns the data of the
initially created order. The response will have a 201 response code. These responses
fail to create any further orders.

It also allows for retrieving by external_id instead of id only.

payment
object
Show object properties
Property Type Description
subtotal
number double

Total price of the order before fees, denominated in currency_code.

total
number double

Total price of the order including fees, denominated in currency_code.

fees
number double

Fees for the order, denominated in currency_code.

discount
number double

Discount for the order, denominated in currency_code.

currency_code
string

Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated.

This always matches the organization's currency.

refund
object

Breakdown of the order refunds (total denominated in currency_code, independent of the ordered rewards' currency). Note that this property will only appear for canceled orders or orders with canceled rewards.

Show object properties
Property Type Description
total
number double

Total amount of the order refunds, denominated in currency_code.

currency_code
string

Currency of the refund. Always matches the organization's currency.