get
https://api-sandbox.urbanpayx.com/api/v1/transactions
List transactions
Returns a paginated list of transactions for the authenticated client.
Optionally filter by status, project, or user.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns a paginated list of transactions belonging to the authenticated client, newest first. Optional query filters narrow the results by status, project, subject, or creation-time range. This is a read-only endpoint with no side effects.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
transactions.readpermission and have the OWNER, DEVELOPER, or OPERATIONS role.
Filters
All filters are optional and combine with AND. Results are always scoped to your own client; transactions belonging to other clients are never returned.
| Query parameter | Type | Description |
|---|---|---|
status | enum | Return only transactions in this status: pending, processing, success, failed, expired, or canceled. |
project_id | string | Return only transactions for this project. |
user_id | string | Return only transactions initiated by this individual customer. |
business_customer_id | string | Return only transactions for this business customer. |
date_from | date-time (ISO 8601) | Inclusive lower bound on creation time. |
date_to | date-time (ISO 8601) | Inclusive upper bound on creation time. |
Pagination
| Query parameter | Type | Default | Constraints |
|---|---|---|---|
page | integer | 1 | Minimum 1. |
page_size | integer | 10 | Between 1 and 100. |
Response
200 OK returns a TransactionListResponse:
transactions— an array of transaction objects on the current page, ordered bycreated_atdescending. Each object includesid,status,reconciliation_state,amount,currency,user_id,business_customer_id,project_id,contract_request_id,checkout_url,checkout_url_v2,transfer_id,created_at,updated_at,intent_expires_at,intent_canceled_at,last_session_minted_at, andsession_count.pagination—total,page,page_size, andtotal_pages.
Error responses
| Status | When |
|---|---|
422 | A query parameter failed validation (e.g. an unknown status value, or page/page_size outside the allowed range). |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.