Check NQR Transaction Status

POST /payments/nqr/transactions/status

Description

Check the status of NQR (Quick Response) transactions within a specified time range.

Request Body

• Media Type: application/json

Name	Type	Description
MerchantId*	string	(Required) Identifier for the merchant.
TerminalId*	string	(Required) Identifier for the payment terminal.
StartTime*	string	(Required) Start time for the transaction status check (in ISO 8601 format).
EndTime*	string	(Required) End time for the transaction status check (in ISO 8601 format).

Example

Request Body

{
  "MerchantId": "merchant_id_123",
  "TerminalId": "terminal_id_456",
  "StartTime": "2023-12-12T02:23:28.501Z",
  "EndTime": "2023-12-12T02:30:00.000Z"
}

cURL

curl --location 'http://20.87.230.105/platform/wallets////payments/nqr/transactions/status' \
--header 'apiKey: yourApiKey' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer yourAccessToken' \
--data '{
  "requestId": "ussd_request_123",
  "accountId": "user_account_456",
  "userId": "user_id_789",
  "amount": 100,
  "bankCode": "bank_code_xyz"
}'

Responses

This section outlines the possible responses from the USSD payment initiation API.

Success Response (200)

The Success Response (200) is returned when the USSD payment request is successfully initiated. This response indicates the success or failure of the operation and provides additional details.

Response Fields

Field	Type	Description
status	boolean	Indicates the success of the USSD payment request.
statusCode	integer	Numeric code representing the status of the response (e.g., 0 for success).
message	string	A message indicating the outcome of the operation.
data	object	An empty object, as no additional data is returned in a successful response.
errors	array	An array of objects providing details about any errors encountered during the request.

Example

JSON:

{
  "status": true,
  "statusCode": 0,
  "message": "USSD payment request initiated successfully",
  "data": {},
  "errors": []
}

Media Type

• application/json: The response is in JSON format.

Example Value

Schema:

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Method: POST

>http://20.87.230.105/platform/wallets////payments/nqr/transactions/status

Headers

Content-Type	Value
apiKey	{{apiKey}}

Body (raw)

{
  "requestId": "ussd_request_123",
  "accountId": "user_account_456",
  "userId": "user_id_789",
  "amount": 100,
  "bankCode": "bank_code_xyz"
}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string