A Transaction represents the public information available for an Ansa transaction. All movements of money through our closed-loop system will have a corresponding transaction, such as for each Add Balance, Use Balance, or Fund Balance request.
Transaction Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
transactionId | string | Unique identifier for the transaction. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
transactionType | string | The type of transaction. Possible values are: - add_balance- use_balance- merchant_refund- refund_payment_method- merchant_add_promo | use_balance |
amount | integer | The transaction amount. Always a positive integer, in the smallest currency unit used in the original transaction (eg $10.00 USD would be 1000). | |
created | timestamp | The timestamp (in RFC 3339 format) when the transaction was created. | 2022-12-08T23:47:41.643Z |
transactionSource | string | What source created this transaction. Possible values are: - addBalance- useBalance- useBalanceAndReload- autoReload | |
paymentMethodId | string | The identifier of which payment method was associated with this transaction. Only present for add_balance transactions. | |
reason | string | Merchant supplied a reason for why the transaction occurred. Only present for merchant_refund or merchant_add_promo transactions. | |
from | string | Unique identifier for who this transaction was from. Either the merchant ID or a customer ID. | |
to | string | Unique identifier for who this transaction was to. Either the merchant ID or a customer ID. | |
metadata | object | Free form metadata JSON object. This will exactly match any metadata argument passed to a transaction API, such as Add balance, Use balance, or Fund customer balance. | |
label | string | Merchant provided label for this transaction. Often used to store a reference to another system, such as an OrderId or an EventId within your system. |