curl --request POST \
--url https://dev.waftpay.io/tsq/v1/query/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transaction_reference": "TXN213687756272200"
}
'{
"status": "<string>",
"code": "<string>",
"description": "<string>",
"data": {
"transaction_reference": "<string>",
"payment_reference": "<string>",
"time_received": "2023-11-07T05:31:56Z",
"amount": 123,
"total_charges": 123,
"total_amount": 123,
"payment_uuid": "<string>",
"state": "<string>",
"last_updated": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}{
"code": "400.001.100",
"status": "REJECTED",
"description": "Invalid or expired token",
"data": {}
}{
"error": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}Collections
Check Collection Status
Retrieve the latest status of a collection using your reference or UUID.
POST
/
tsq
/
v1
/
query
/
payments
curl --request POST \
--url https://dev.waftpay.io/tsq/v1/query/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transaction_reference": "TXN213687756272200"
}
'{
"status": "<string>",
"code": "<string>",
"description": "<string>",
"data": {
"transaction_reference": "<string>",
"payment_reference": "<string>",
"time_received": "2023-11-07T05:31:56Z",
"amount": 123,
"total_charges": 123,
"total_amount": 123,
"payment_uuid": "<string>",
"state": "<string>",
"last_updated": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}{
"code": "400.001.100",
"status": "REJECTED",
"description": "Invalid or expired token",
"data": {}
}{
"error": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}Overview
Query the current status of a collection using one of your identifiers. This endpoint is useful for reconciliation or when webhooks are delayed.
Auth: Requires a Collection token (Authorization: Bearer <collection_token>).
Endpoint
POST https://api.waftpay.io/tsq/v1/query/payments
POST https://dev.waftpay.io/tsq/v1/query/payments
Request body
Provide one of the following fields:| Field | Type | Notes |
|---|---|---|
transaction_reference | string | Your client reference used when creating the collection. |
request_uuid | string | Request UUID returned by the platform (if provided). |
payment_uuid | string | Waftpay payment UUID (numeric string). |
Example (by transaction reference)
{
"transaction_reference": "TNC000008"
}
Example (by payment UUID)
{
"payment_uuid": "8363546214883574601"
}
Example response
{
"status": "200.100",
"code": "ACCEPTED",
"description": "Accepted for processing",
"data": {
"amount": 1000,
"total_charges": 0,
"total_amount": 1000,
"transaction_reference": "TNC000008",
"payment_uuid": "8363546214883574601",
"payment_reference": "1RJITP5HLL",
"state": "processing",
"time_received": "2025-04-04T06:13:52.585619Z",
"last_updated": "2025-04-04T06:15:10.102993Z"
}
}
Notes
statecan beprocessing,succeeded,failed, orcanceled.- If the collection is not found, you will receive a
NOT_FOUNDresponse. payment_referenceis a separate Waftpay reference; do not send it aspayment_uuid.- Errors follow the standard error shape. See Errors.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json