> For the complete documentation index, see [llms.txt](https://docs.pay.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pay.io/api-reference/user-payment-api/get-a-list-of-user-transactions.md).

# Get a List of User Transactions

## List user transactions

> This API endpoint retrieves a paginated list of transactions for a specific user reference. It supports filtering by transaction types, time ranges, and provides cursor-based pagination for efficient data retrieval. The response includes detailed transaction information along with currency metadata and pagination controls.

```json
{"openapi":"3.0.0","info":{"title":"pay.io payment gateway","version":"1.0"},"servers":[{"url":"https://gateway.stage.pay.io","variables":{}}],"paths":{"/v1/user/transactions":{"post":{"callbacks":{},"description":"This API endpoint retrieves a paginated list of transactions for a specific user reference. It supports filtering by transaction types, time ranges, and provides cursor-based pagination for efficient data retrieval. The response includes detailed transaction information along with currency metadata and pagination controls.","operationId":"HubwalletPaymentGatewayWeb.Controller.Merchant.Default.list_transactions","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_Transactions_Request"}}},"description":"Transaction list parameters","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_Transactions_Response"}}},"description":"Transaction list"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Validation_Error_Response"}}},"description":"Validation error - missing required fields or invalid user_reference_id format (only alphanumeric, hyphens, and underscores allowed)"}},"summary":"List user transactions","tags":["user"]}}},"components":{"schemas":{"List_Transactions_Request":{"description":"Request to list transactions","properties":{"after":{"description":"Cursor to paginate after (for forward pagination)","type":"string"},"before":{"description":"Cursor to paginate before (for backward pagination)","type":"string"},"first":{"description":"Number of transactions to return","type":"integer"},"last":{"description":"Return the last N transactions (backward pagination)","type":"integer"},"time_range":{"description":"Time range filter - today, yesterday, this_week, this_month, last_month, last_24hrs","format":"date","type":"string"},"transaction_types":{"description":"Filter by transaction Type Deposit or Payout","items":{"enum":["Deposit","Payout"],"type":"string"},"type":"array"},"user_reference_id":{"description":"User reference identifier","type":"string"}},"required":["user_reference_id"],"title":"List_Transactions_Request","type":"object"},"List_Transactions_Response":{"description":"Response containing transaction history with edges structure","properties":{"edges":{"items":{"properties":{"cursor":{"description":"Edge cursor for pagination","type":"string"},"inserted_at":{"description":"Edge insertion timestamp (ISO 8601)","format":"date-time","type":"string"},"node":{"properties":{"amount":{"description":"Transaction amount","type":"string"},"amount_usd":{"description":"Transaction amount in USD","nullable":true,"type":"string"},"completed_at":{"description":"Transaction completion timestamp (ISO 8601)","format":"date-time","nullable":true,"type":"string"},"correlation_key":{"description":"Internal tracking identifier","type":"string"},"currency":{"description":"Currency object","properties":{"code":{"description":"Currency code","type":"string"},"currency_icon":{"description":"Currency icon URL","type":"string"},"id":{"description":"Currency ID","format":"uuid","type":"string"},"name":{"description":"Currency name","type":"string"},"network":{"description":"Blockchain network","type":"string"},"network_icon":{"description":"Network icon URL","type":"string"},"symbol":{"description":"Currency symbol","type":"string"},"token_address":{"description":"Token contract address","nullable":true,"type":"string"}},"required":["code","id","name","symbol","network","currency_icon","network_icon"],"type":"object"},"failure_reason":{"description":"Failure reason if transaction failed","nullable":true,"type":"string"},"from_address":{"description":"Source wallet address","nullable":true,"type":"string"},"inserted_at":{"description":"Transaction insertion timestamp (ISO 8601)","format":"date-time","type":"string"},"merchant_status":{"description":"Merchant callback status","type":"string"},"provider_transaction_id":{"description":"Provider transaction identifier","nullable":true,"type":"string"},"provider_wallet_reference":{"description":"Provider wallet reference","nullable":true,"type":"string"},"status":{"description":"Transaction status","enum":["TXN_NEW","TXN_PROVIDER_PROCESSING","TXN_PROVIDER_SUCCEEDED","TXN_PENDING_APPROVAL","TXN_APPROVED","TXN_REJECTED","TXN_PROVIDER_FAILED"],"type":"string"},"to_address":{"description":"Destination wallet address","nullable":true,"type":"string"},"transaction_data":{"additionalProperties":true,"description":"Additional transaction data","type":"object"},"transaction_uuid":{"description":"Transaction UUID","format":"uuid","type":"string"},"trn_provider_ref":{"description":"Transaction provider reference","nullable":true,"type":"string"},"tx_hash":{"description":"Blockchain transaction hash","nullable":true,"type":"string"},"type":{"description":"Type of transaction: Deposit or Payout","enum":["Deposit","Payout"],"type":"string"},"updated_at":{"description":"Transaction update timestamp (ISO 8601)","format":"date-time","type":"string"},"user_ref_id":{"description":"User reference identifier","type":"string"}},"required":["status","type","currency","amount","inserted_at","updated_at","user_ref_id","transaction_uuid","correlation_key","merchant_status","transaction_data"],"type":"object"}},"required":["node","cursor","inserted_at"],"type":"object"},"type":"array"},"page_info":{"description":"Pagination cursor information","properties":{"end_cursor":{"description":"Cursor for the last item in this page","type":"string"},"has_next_page":{"description":"Whether more results are available","type":"boolean"},"has_previous_page":{"description":"Whether previous results are available","type":"boolean"},"start_cursor":{"description":"Cursor for the first item in this page","type":"string"}},"required":["end_cursor","has_next_page","has_previous_page","start_cursor"],"type":"object"},"total_count":{"description":"Total number of transactions","type":"integer"}},"required":["edges","page_info","total_count"],"title":"List_Transactions_Response","type":"object"},"Validation_Error_Response":{"description":"Validation error response format","properties":{"error":{"description":"Error message","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Field-specific validation errors","type":"object"}},"required":["error","errors"],"title":"Validation_Error_Response","type":"object"}}}}
```


---

# 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.pay.io/api-reference/user-payment-api/get-a-list-of-user-transactions.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.
