curl -X GET https://payx.company/api/v1/status/sample_tx_12345678 \
-H "x-api-key: px_live_v2_YOUR_SECRET_KEY"
const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: process.env.PAYX_SECRET_KEY });
const res = await payx.charge.getStatus('sample_tx_12345678');
console.log('Status:', res.status);
{
"transactionId": "sample_tx_12345678",
"status": "SUCCESSFUL",
"amount": 10.00,
"currency": "GHS",
"reference": "ORD-1001"
}
API Reference
Get Transaction Status
Retrieve the latest status of a charge or payout transaction
GET
/
status
/
{transactionId}
curl -X GET https://payx.company/api/v1/status/sample_tx_12345678 \
-H "x-api-key: px_live_v2_YOUR_SECRET_KEY"
const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: process.env.PAYX_SECRET_KEY });
const res = await payx.charge.getStatus('sample_tx_12345678');
console.log('Status:', res.status);
{
"transactionId": "sample_tx_12345678",
"status": "SUCCESSFUL",
"amount": 10.00,
"currency": "GHS",
"reference": "ORD-1001"
}
Authentication
This endpoint requires your v2 secret API key:- Header:
x-api-key: px_live_v2_...orAuthorization: Bearer px_live_v2_...
Path Parameters
string
required
The unique transaction identifier returned when creating a charge or payout.
Response
string
The unique transaction ID.
string
Current transaction status:
PENDING, SUCCESSFUL, or FAILED.number
The transaction amount.
string
Currency code (e.g.
GHS).string
Your custom merchant reference or internal reference.
curl -X GET https://payx.company/api/v1/status/sample_tx_12345678 \
-H "x-api-key: px_live_v2_YOUR_SECRET_KEY"
const { PayX } = require('payx-node');
const payx = new PayX({ apiKey: process.env.PAYX_SECRET_KEY });
const res = await payx.charge.getStatus('sample_tx_12345678');
console.log('Status:', res.status);
{
"transactionId": "sample_tx_12345678",
"status": "SUCCESSFUL",
"amount": 10.00,
"currency": "GHS",
"reference": "ORD-1001"
}