Create a new NQR Terminals

POST /payments/nqr/terminals

Description

Register a new NQR (Quick Response) terminal for a merchant.

Required Headers

	Type	Description
apiKey	string	(Required). Wallet API key for authentication. Include in the request header.
Authorization	string	(Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm...

Request Body

• Media Type: application/json

Name	Type	Description
merchantID*	string	(Required) Identifier for the merchant.
accountId*	string	(Required) Identifier for the user's account.
TerminalName*	string	(Required) Name or label for the NQR terminal.
Email*	string	(Required) Email address associated with the NQR terminal.
PhoneNumber*	string	(Required) Phone number associated with the NQR terminal.
QrType*	string	(Required) Type of QR code supported by the terminal.

Example

cURL

curl --location 'http://20.87.230.105/platform/wallets/payments/nqr/terminals' \
--header 'apiKey: yourApiKey' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer yourAccessToken' \
--data-raw '{
  "merchantID": "merchant_id_123",
  "accountId": "user_account_456",
  "TerminalName": "POS Terminal",
  "Email": "terminal@example.com",
  "PhoneNumber": "+1234567890",
  "QrType": "STATIC"
}'

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.

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": []
}

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/terminals

Headers

Content-Type	Value
apiKey	{{apiKey}}

Body (raw)

{
  "merchantID": "merchant_id_123",
  "accountId": "user_account_456",
  "TerminalName": "POS Terminal",
  "Email": "terminal@example.com",
  "PhoneNumber": "+1234567890",
  "QrType": "STATIC"
}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string