Transaction Object


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

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

Amount the balance was adjusted in this transaction.


beneficiaryIdentificationDataRead-onlyimmutable

Beneficiary of the pool associated with this transaction.


createdDatestringRead-onlyformat date-time

Date and time the transaction was created.


detailsTransactionDetailsRead-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.


externalIdstringRead-onlyformat GUIDimmutable

External transaction ID.


idstringRead-onlyformat GUID

Transaction ID.


idempotencyKeystringRead-onlymaxLength 200

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


instructingPartyIdentificationDataRead-onlyimmutable

Identity that created the transaction.


poolPoolInfoRead-only

Pool associated with this transaction.


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.


revisionstringRead-onlyformat int64

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


sourcestring

Where the credits came from.


statusstring

Transaction status.


targetstring

Where the credits went to.


updatedDatestringRead-onlyformat date-time

Date and time the transaction was updated.

Did this help?