Transaction Object


A transaction is a record of a change to a balance.

Properties
idstringRead-onlyformat GUID

Transaction ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the transaction is updated.


createdDatestringRead-onlyformat date-time

Date and time the transaction was created.


updatedDatestringRead-onlyformat date-time

Date and time the transaction was updated.


poolPoolRead-only

Pool associated with this transaction.


amountstringdecimalValue {"gte":"0","maxScale":4}

Amount the balance was adjusted in this transaction.


sourcestring

Where the credits came from.


targetstring

Where the credits went to.


idempotencyKeystringRead-onlymaxLength 200

Unique identifier, generated by the client. Used to recognize repeated attempts to make the same request.


relatedTransactionIdstringRead-onlyformat GUID

ID of the related transaction. For example, if this transaction is a refund for a benefit redemption, the related transaction is the benefit redemption transaction.


beneficiaryBeneficiaryRead-onlyimmutable

Beneficiary of the pool associated with this transaction.


instructingPartyInstructingPartyRead-onlyimmutable

Identity that created the transaction.


statusstring

Transaction status.


detailsDetailsRead-only

Additional transaction details.


extendedFieldsExtendedFields

Custom field data for the transaction object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.

Did this help?