Wallet Transactions API

This document provides a comprehensive guide to fetch your payout wallet transaction data from Pay Agency's API.

API Endpoints

GET https://backend.pay.agency/api/v1/live-wallet-transactions

Authentication

All API requests require authentication using your secret key in the Authorization header.

Authorization: Bearer YOUR_SECRET_KEY

Query Parameters

The API supports the following query parameters to filter and paginate transaction data:

Parameter	Type	Description	Required
`transaction_start_date`	String	Start date for filtering transactions (YYYY-MM-DD format)	No
`transaction_end_date`	String	End date for filtering transactions (YYYY-MM-DD format)	No
`nextCursor`	String	Cursor for next page of results	No
`prevCursor`	String	Cursor for previous page of results	No

Example Request

curl --location 'https://backend.pay.agency/api/v1/live-wallet-transactions?transaction_start_date=2023-05-01&transaction_end_date=2023-05-15' \
--header 'Authorization: Bearer YOUR_SECRET_KEY'

Response Structure

{
  "message": "Transactions fetched successfully ",
  "data": [ ... array of wallet transaction objects ... ],
  "meta": {
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextCursor": "MQ==",
    "prevCursor": "MTI=",
    "totalCount": 12
  }
}

Wallet Transaction Object Properties

Note: The wallet_id and transaction_date fields are not available in test wallet transactions. These fields are only present in live wallet transactions.

Property	Type	Description
wallet_id	String	Unique identifier for the wallet
first_name	String	First name of the account holder
last_name	String	Last name of the account holder
transaction_id	String	Unique identifier for the transaction
amount	String	Transaction amount
address	String	Address associated with the wallet (if any)
currency	String	Currency code for the transaction
status	String	Status of the transaction (SUCCESS, FAILED, etc.)
card_type	String	Type of card used (e.g., MASTER)
card_number	String	Masked card number
card_expiry_month	String	Card expiry month
card_expiry_year	String	Card expiry year
transaction_type	String	Type of transaction (CARD, APM, etc.)
order_id	String	Unique order ID (if provided)
message	String	Transaction message or remark
phone_number	String	Phone number associated with the transaction
fee	String	Fee charged for the transaction
country	String	Country code
email	String	Email address
created_at	String	Transaction creation timestamp
transaction_date	String	Transaction processing timestamp

Example Response

{
  "message": "Transactions fetched successfully ",
  "data": [
    {
      "wallet_id": "WAL7447284777737475",
      "first_name": "James",
      "last_name": "Dean",
      "transaction_id": "REF_PA8373919316726292",
      "amount": "31.82",
      "address": "64 Hertingfordbury Rd",
      "currency": "EUR",
      "status": "SUCCESS",
      "card_type": "MASTER",
      "card_number": "551928XXXXXX0000",
      "card_expiry_month": "12",
      "card_expiry_year": "2027",
      "transaction_type": "CARD",
      "order_id": null,
      "message": "Refund processed for failed payout",
      "phone_number": "7654233212",
      "fee": "1.82",
      "country": "US",
      "email": "james@gmail.com",
      "created_at": "2025-05-16T08:22:19.217Z",
      "transaction_date": "2025-05-16T08:22:20.148Z"
    },
    // ...more transactions...
  ],
  "meta": {
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextCursor": "MQ==",
    "prevCursor": "MTI=",
    "totalCount": 12
  }
}

Pagination

The API response includes pagination metadata that can be used to fetch additional pages of transaction data:

hasNextPage: Boolean indicating if there are more transactions available after this page
hasPreviousPage: Boolean indicating if there are transactions available before this page
nextCursor: Cursor string to fetch the next page of results (use with nextCursor parameter)
prevCursor: Cursor string to fetch the previous page of results (use with prevCursor parameter)
totalCount: Total number of transactions matching the current filter criteria

Example: Fetching the Next Page

const nextPageUrl = 'https://backend.pay.agency/api/v1/live-wallet-transactions?nextCursor=MQ==';
 
fetch(nextPageUrl, {
  headers: {
    'Authorization': 'Bearer YOUR_SECRET_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Error Responses

{
  "message": "Authentication token is missing or invalid."
}

{
  "message": "Authentication Secret Key is missing."
}

{
  "message": "Invalid Live Secret Key."
}

Wallet Transactions API

On this page