Skip to main content
GET
/
transactions
/
all
List all transactions (admin)
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/transactions/all \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "data": [
    {
      "transaction_id": "<string>",
      "user_id": "<string>",
      "beneficiary_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "type": "inbound",
      "status": "initiated",
      "payment_method": "bank_transfer",
      "payment_id": "<string>",
      "payout_id": "<string>",
      "org_id": "<string>",
      "country": "<string>",
      "entity_type": "<string>",
      "target_amount": 123,
      "target_currency": "<string>",
      "metadata": {},
      "beneficiary_details": {},
      "compound_amount": 123,
      "duration": 123,
      "installment_amount": 123,
      "total_installments": 123,
      "installments_completed": 123,
      "amount_paid": 123,
      "outstanding_balance": 123,
      "next_due_date": "2023-11-07T05:31:56Z",
      "start_date": "2023-11-07T05:31:56Z",
      "frequency": "weekly",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextToken": "<string>",
    "pageSize": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Query Parameters

pageSize
integer
default:10
Required range: x <= 100
nextToken
string

JSON-encoded DynamoDB cursor from the previous page.

status
enum<string>
Available options:
initiated,
pending,
completed,
failed
dateFrom
string<date>
dateTo
string<date>

Response

Paginated transaction list

data
object[]
pagination
object