Payment Status
Q Endpoints
getPaymentStatus
This call will provide you with the current status of the transaction.
Request Method
GET
Inputs
M = Mandatory
O = Optional
C = Conditional
Name | Status | Description |
---|---|---|
merchant_id (M) | string | Your merchant id provided to you by Q |
login_id (M) | string | Your login id provided to you by Q |
Password (M) | string | Your password provided to you by Q |
api_key (M) | string | Key defined by Q for this service |
process_no (M) | string | Value that was returned by the GetPaymentURL service. |
merchant_transaction_id (M) | string | The same value that you passed to the GetPaymentURL service. |
transmission_date_time (M) | string | Timestamp when this request is generated. The format is: yyyyMMddHHmmss where: yyyy = year represented with four digits MM = two digit month in the year number (1-12) dd = two digit day in the month number (1-31) HH = two digit hour in a day number (00-23) mm = two digit minutes in an hour number (00-59) ss = two digit seconds in a minute number (00-59) |
Outputs
Name | Type | Description |
---|---|---|
result | Result | See Response Codes below |
resultCode | string | Element of the Result entity. Code that uniquely defines result of the processing payment |
resultDesc | string | Element of the Result entity. Description of the processing result |
paymentStatus | PaymentStatus | See Payment Statuses above |
statusCode | string | Code that defines the current status of the transaction. |
statusDesc | string | Description of the status |
retrieval_reference_number | string | A unique number generated by Q for this payment. Can be used for reconciliation (RRN) |
selected_product_code | string | Finance product code selected by the customer |
merchant_transaction_id | string | Transaction ID as supplied by you |
transmissionDateTime | string | Timestamp when the response is generated. The format is: yyyyMMddHHmmss where: yyyy = year represented with four digit MM = two digit month in the year number (1-12) dd = two digit day in the month number (1-31) HH = two digit hour in a day number (00-23) mm = two digit minutes in an hour number (00-59) ss = two digit seconds in a minute number (00-59) |
Note:
The Retrieval Reference Number (RRN) is only available when the transaction has been completed.
Examples
HTTP Method:
GET
REST Example Request
https://api.flexilongtermfinance.co.nz/api/simulator/gateway/rest/v1/payment/paymentstatus?merchant_id=12321&login_id=203399&password=Password01&api_key=2bef9740cd0be5995e58f9eef3249cabbd65d4bc&process_no=2000&merchant_transaction_id=123&transmission_date_time=20161711101240
REST Example Response - Success
{
"result": {
"resultCode": "00",
"resultDesc": "ACCEPT_SUCCESSFUL"
},
"paymentStatus": {
"statusCode": "00",
"statusDesc": "APPROVED"
},
"retrieval_reference_number": null,
"selected_product_code": 6_MTHS,
"merchant_transaction_id": 123
}
REST Example Response - Unsuccessful
{
"result": {
"resultCode": "203",
"resultDesc": "SYSTEM_ERROR"
},
"paymentStatus": {
"statusCode": "",
"statusDesc": ""
},
"retrieval_reference_number": null,
"selected_product_code": “”,
"merchant_transaction_id": “”
}
Response Codes
The four possible status responses are:
Code | Value | Description |
---|---|---|
00 | ACCEPT_SUCCESSFUL | Web service was successful |
202 | NOT_VALID | Unrecoverable error. Flexi Cards should be notify when this occurs |
204 | INVALID_USER_DETAIL | Either username or password was incorrect |
209 | ACCESS_NOT_ALLOWED | Either the API key is invalid or the service has been disabled |
Updated 3 months ago