Comment on page
Transactions
The Transactions API allows you to retrieve information on all charges and top-ups on your account.
This section describes the different attributes available for a transaction.
Attribute | Type | Description |
amount | number | Total amount for transaction. |
currency | string | Currency for transaction. |
description | string | Human readable description explaining the transaction. e.g. Billing charge for DHL Express shipment [AG2345] to John Doe. |
flow | enum | Indicates the flow of the transaction. e.g. in - represents money into a wallet while out - represents money deducted from a wallet. |
id | string | Unique identifier for transaction. |
platform | enum | Unique reference for platform processing transaction. Options available are shipmonk or terminal. |
reference | string | Unique reference for transaction provided by processing platform. |
reversed | boolean | Indicates if transaction has been reversed to wallet. |
shipment | string | Unique reference for shipment. Only supplied if transaction related to a specific shipment. |
transaction_id | string | Unique reference for transaction. |
wallet | string | Unique identifier for wallet. |
created_at | datetime | Time transaction created. |
updated_at | datetime | Time transaction last updated. |
Last modified 1yr ago