Pay-In History

API Endpoints

Live APIProduction environment

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

Test APISandbox environment

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

Response Format

The API response returns transaction data together with pagination metadata.

{
  "message": "Transactions fetched successfully",
  "data": [ ... array of transaction objects ... ],
  "meta": {
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "NTQ1",
    "prevCursor": "NTY0",
    "totalCount": 144
  }
}

Transaction Object Fields

Each transaction object in the response includes the following fields:

Property	Type	Description
`first_name`	String	Customer first name
`last_name`	String	Customer last name
`converted_amount`	String	Transaction amount converted into the display currency
`converted_currency`	String	Currency code for the converted amount
`transaction_id`	String	Unique transaction identifier
`amount`	String	Original transaction amount
`currency`	String	Original transaction currency
`status`	String	Transaction status, such as SUCCESS or FAILED
`card_type`	String	Card brand or type used, such as VISA or MASTERCARD
`card_number`	String	Masked card number
`transaction_type`	String	Transaction category, such as CARD or APM
`order_id`	String	Unique order ID, if supplied
`country`	String	Country code for the transaction origin
`email`	String	Customer email address
`created_at`	String	Timestamp when the transaction was created
`transaction_date`	String	Timestamp when the transaction was processed
`chargeback_date`	String	Chargeback date, if applicable
`refund_date`	String	Refund date, if applicable
`suspicious_date`	String	Date when the transaction was flagged as suspicious
`merchant_connector`	Object	Payment processor information
`user`	Object	Merchant user details

Sample Responses

{
"message": "Transactions fetched successfully",
"data": [
  {
    "first_name": "James",
    "last_name": "Karlo",
    "converted_amount": "200",
    "converted_currency": "USD",
    "transaction_id": "TPC3060287394219373",
    "amount": "200",
    "currency": "USD",
    "status": "SUCCESS",
    "card_type": null,
    "card_number": null,
    "transaction_type": "APM",
    "order_id": null,
    "country": "IN",
    "email": "james.karlo@gmail.com",
    "created_at": "2025-05-13T10:03:22.878Z",
    "transaction_date": "2025-05-13T10:03:22.886Z",
    "chargeback_date": null,
    "refund_date": null,
    "suspicious_date": null,
    "merchant_connector": {
      "name": "test MID"
    },
    "user": {
      "name": "James dean",
      "user_kyc": {
        "name": "James dean"
      }
    }
  }
],
"meta": {
  "hasNextPage": true,
  "hasPreviousPage": false,
  "nextCursor": "NTQ1",
  "prevCursor": "NTY0",
  "totalCount": 144
}
}

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-transactions?nextCursor=NTQ1';

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

Pay-In History

On this page