Create a Dynamic NQR

POST /payments/nqr/invokedynamicqr

Description

Initiate the creation of a dynamic NQR (Quick Response) code for a payment transaction.

Request Body

• Media Type: application/json

Name	Type	Description
transactionCategory*	string	(Required) Category of the transaction, e.g., "Sales".
requestID*	string	(Required) Unique identifier for the payment request.
accountId*	string	(Required) Identifier for the payer's account.
MerchantId*	string	(Required) Identifier for the merchant receiving the payment.
Amount*	number	(Required) Amount of the payment transaction.
TraceId*	string	(Required) Unique identifier for tracing the transaction.

Example

cURL

curl --location 'http://20.87.230.105/platform/wallets/payments/nqr/invokedynamicqr' \
--header 'apiKey: yourApiKey' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer yourAccessToken' \
--data '{
  "Tin": "merchant_tin_123",
  "ContactName": "John Doe",
  "AccountNumber": "1234567890",
  "AccountName": "Merchant Enterprises"
}
'

Success Response (200)

The Success Response (200) is returned when the USSD payment request is successfully initiated. This response indicates the success 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": []
}

Method: POST

>http://20.87.230.105/platform/wallets/payments/nqr/invokedynamicqr

Headers

Content-Type	Value
apiKey	{{apiKey}}

Body (raw)

{
  "Tin": "merchant_tin_123",
  "ContactName": "John Doe",
  "AccountNumber": "1234567890",
  "AccountName": "Merchant Enterprises"
}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string