> For the complete documentation index, see [llms.txt](https://docs.terminal.africa/tship/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terminal.africa/tship/transaction.md).

# Transactions

The Transactions API allows you to retrieve information on all charges and top-ups on your account.

### The Transaction Object

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.terminal.africa/tship/transaction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.