NQR Merchant

POST /payments/nqr/merchants

Description

The endpoint allows users to register a new merchant in the NQR (Quick Response) system. Merchants, businesses that sell goods or services, can utilize NQR codes for efficient and quick payment transactions.

Request Body

• Media Type: application/json

Name	Type	Description
Tin	string	(Required) Tax Identification Number (TIN) for the merchant.
ContactName*	string	(Required) Name of the contact person for the merchant.
AccountNumber	string	(Required) Bank account number associated with the merchant.
AccountName	string	(Required) Bank account name associated with the merchant.

Example

cuRL

curl --location 'http://20.87.230.105/platform/wallets/payments/nqr/merchants' \
--header 'apiKey: 6987f1c0-f01f-4b31-86e5-416ccaa906de' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2NmNmYWQ2NWQ1NTNhZDYwOTBiY2IiLCJmaXJzdE5hbWUiOiJTQUJJIE5HIiwibGFzdE5hbWUiOiJQbGF0Zm9ybSIsInVzZXJuYW1lIjoidGVjaEBzYWJpLmFtIiwicGFzc3dvcmQiOm51bGwsInR5cGUiOiJVU0VSIiwiY291bnRyeSI6eyJuYW1lIjoiTmlnZXJpYSIsImNvZGUiOiJORyIsImN1cnJlbmN5IjoiTkdOIiwiX2lkIjoiNjRkNjZjZmFkNjVkNTUzYWQ2MDkwYmNjIn0sInRlbmFudHMiOlsiNjRkYjY4NmIzZjljNGJjMThkNWM2NTA3IiwiNjRmYjMzYjEwMTUzMWNkYWFhZTlkMzM5Il0sInJvbGVzIjpbIlRFTkFOVF9TVVBFUl9BRE1JTiIsIlRFTkFOVF9BRE1JTiJdLCJpYXQiOjE3MDIyOTgyODgsImV4cCI6MTcwMjkwMzA4OH0.9BIMwE8o52p1-KPX9M7xmtXVNC86yWypbUejtMpvJC8' \
--data '{
  "Tin": "merchant_tin_123",
  "ContactName": "John Doe",
  "AccountNumber": "1234567890",
  "AccountName": "Merchant Enterprises"
}

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

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