Payout History

API Endpoints

Live APIProduction environment

GEThttps://api.thepayment.company/api/v1/live-wallet-transactions

Test APISandbox environment

GEThttps://api.thepayment.company/api/v1/test-wallet-transactions

Authentication

All API requests must be authenticated with your secret key in the Authorization header.

Authorization: Bearer YOUR_SECRET_KEY

Query Parameters

Supported query parameters for transaction filtering and pagination are listed below:

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://api.thepayment.company/api/v1/live-wallet-transactions?transaction_start_date=2023-05-01&transaction_end_date=2023-05-15'   --header 'Authorization: Bearer YOUR_SECRET_KEY'

Response Format

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

Wallet Transaction Fields

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

Property	Type	Description
wallet_id	String	Unique wallet identifier
first_name	String	Account holder first name
last_name	String	Account holder last name
transaction_id	String	Unique transaction identifier
amount	String	Transaction amount
address	String	Wallet-related address, if available
currency	String	Transaction currency code
status	String	Transaction status, such as SUCCESS or FAILED
card_type	String	Card type, for example MASTER
card_number	String	Masked card number
card_expiry_month	String	Card expiry month
card_expiry_year	String	Card expiry year
transaction_type	String	Transaction category, such as CARD or APM
order_id	String	Unique order ID, if supplied
message	String	Transaction message or note
phone_number	String	Phone number linked to the transaction
fee	String	Transaction fee
country	String	Country code
email	String	Email address
created_at	String	Timestamp when the transaction was created
transaction_date	String	Timestamp when the transaction was processed

Sample Responses

{
"message": "Transactions fetched successfully ",
"data": [
  {
    "wallet_id": "WAL7447284777737475",
    "first_name": "James",
    "last_name": "Dean",
    "transaction_id": "REF_TPC8373919316726292",
    "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"
  }
],
"meta": {
  "hasNextPage": false,
  "hasPreviousPage": false,
  "nextCursor": "MQ==",
  "prevCursor": "MTI=",
  "totalCount": 12
}
}

Pagination

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

hasNextPage: Indicates whether more transactions exist after the current page
hasPreviousPage: Indicates whether earlier transactions exist before the current page
nextCursor: Cursor value used to request the next page of results with the nextCursor parameter
prevCursor: Cursor value used to request the previous page of results with the prevCursor parameter
totalCount: Total number of transactions matching the current filters

Example: Loading the Next Page

const nextPageUrl = 'https://api.thepayment.company/api/v1/live-wallet-transactions?nextCursor=MQ==';

fetch(nextPageUrl, {
headers: {
  'Authorization': 'Bearer YOUR_SECRET_KEY'
}
})
.then(response => response.json())
.then(data => console.log(data));

Payout History

On this page