7. Query Transaction Status
This page goes into details of how to query the status of a transaction using your generated transaction reference.
Key Definitions
LIVE baseUrl
: https://kola.vpay.africa
SANDBOX baseUrl
: https://zander.vpay.africa
accessToken
: JWT token generated from the login endpoint
There are two endpoints involved as described below.
(a) login
Use this endpoint to authenticate your account and obtain a JWT accessToken for use in subsequent endpoints
This endpoint is throttled to 1 request every 270000 milliseconds.
Request
POST
{{baseUrl}}/api/service/v1/query/merchant/login
Content-Type
application/json
publicKey
{{publicKey}}
The public key supplied by your account manager.
username
Merchant email or phone number
mandatory
password
Merchant password
mandatory
Response Payload Sample
(b) query transaction status
Use this endpoint to query the status of your transaction using your previously generated transaction reference
This endpoint is throttled to 1 request every 1000 milliseconds.
Request
POST
{{baseUrl}}/api/v1/webintegration/query-transaction
Content-Type
application/json
publicKey
{{publicKey}}
b-access-token
{{accessToken}}
Use the token value that was provided in the response payload from the login endpoint above
transactionRef
Your unique transaction reference
case sensitive and mandatory
Response Payload Sample
Last updated