Purpose of GetPaymentStatus

The GetPaymentStatus endpoint is used by the merchant system to retrieve the current status of an IRIS payment after the QR code has been displayed to the final customer (payer).

Before calling GetPaymentStatus, the following conditions must be met:

The merchant must have already successfully called InitiatePayment.

The merchant must have received the endToEndDiasId from the InitiatePayment response.

The QR code must already be displayed to the final customer.

After the QR code is displayed, the merchant system must begin polling this endpoint every 5 seconds until the payment reaches a final state.

This endpoint returns one of the following IRIS status values:

Pending – The payer has not completed the payment yet.

Completed – The payment was successfully completed.

Expired – The QR code validity period expired before payment.

Failed – The payment was not successful.

Statuses Expired and Failed require the merchant to restart the entire IRIS flow (beginning again from InitiatePayment).

The endpoint provides the final confirmation required to complete the transaction and proceed with the submission of the final JSON to the Certified Provider.

Endpoint: {domain}/paymentsapi/IrisPayments/GetPaymentStatus

GetPaymentStatus Request Parameters

The GetPaymentStatus endpoint uses query parameters, not a request body.

Parameter	Type	Required	Description
endToEndDiasId	string	Yes	The unique IRIS payment identifier returned by DIAS in the `InitiatePayment` response. This value is mandatory for retrieving the correct payment status.

Example GetPaymentStatus Request

application/json

Body

Example

{
    "endToEndDiasId": "string",
    "paymentStatus": "Pending",
    "paymentStatusDescription": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "isFinalStatus": true
}

/IrisPayments/GetPaymentStatus

Purpose of GetPaymentStatus

Endpoint: {domain}/paymentsapi/IrisPayments/GetPaymentStatus

GetPaymentStatus Request Parameters

Example GetPaymentStatus Request

Request

Request Code Samples

Responses

/IrisPayments/GetPaymentStatus

Purpose of GetPaymentStatus#

Endpoint: {domain}/paymentsapi/IrisPayments/GetPaymentStatus#

GetPaymentStatus Request Parameters#

Example GetPaymentStatus Request#

Request

Request Code Samples

Responses

Purpose of GetPaymentStatus

Endpoint: {domain}/paymentsapi/IrisPayments/GetPaymentStatus

GetPaymentStatus Request Parameters

Example GetPaymentStatus Request