Skip to main content

Query NQR Payment Status

GET /payments/nqr/status-query/{referenceId}

Description​

Retrieve the status of an NQR payment using the reference ID.

Path Parameters​

NameTypeDescription
referenceIdstringThe unique identifier of the payment (path parameter)

Request Headers​

NameTypeDescription
tenantIdstringThe tenant ID (header)
countryCodestringThe country code (header)

Example​

GET /payments/nqr/status-query/{referenceId}
Accept: application/json
countryCode: string
tenantId: string

Response Code: 200 - OK​

Description​

Successful retrieval of NQR payment status.

Response Fields​

FieldTypeDescription
statusbooleanIndicates if the operation was successful
statusCodeintegerStatus code
messagestringResponse message
dataobjectData related to the NQR payment status
errorsarrayList of error messages, if any

Example​

{
"status": true,
"statusCode": 0,
"message": "NQR payment status retrieved successfully",
"data": {},
"errors": [
{
"message": "Some error occurred",
"descriptiveMessage": "Detailed error message"
}
]
}

Headers​

Content-Typeapplication/json
countryCodestring
tenantIdstring

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /payments/nqr/status-query/{referenceId} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!