API Reference

References

Note: ^ - Attribute with Caret (^) are not in UAT/Prod env and are in proposal phase.

Checkout Transaction Status

Response StatusResponse MessageTerminal State?HTTP Status Code
CREATEDTransaction is created, and waiting for the application to redirect the user to checkout app redirectUrlN200
PROCESSINGUser is redirected by the app to checkout redirectUrlN200
PROCESSEDTransaction is processed successfullyY200
AUTHORIZEDTransaction is authorized with the PG but not yet capturedN200
AUTHORIZATION_FAILEDTransaction is not authorized by processor due to technical issues at PGY200
AUTHORIZATION_DECLINEDTransaction is declined by vendor/processorY200
CAPTURE_PENDINGTransaction is waiting to be captured by gateway/processorN200
CANCEL_PENDINGTransaction is out for void (cancellation) before being captured by PGN200
CANCELLEDTransaction is voided (cancelled)Y200
REFUNDEDTransaction refunded successfullyY200
ALREADY_REFUNDEDIn case of full refund, when refund has already been processed for transaction, but user is again requesting for refund for same transaction.Y200
ERROR_FROM_PGThis is returned in case of any HTTP code other than 200,404 received from PGN400, 404, 500
ABORTEDThis is returned in case transaction is cancelled by customer at gateway pageY200
ERROR_CONNECTING_PGCheckout facing timeout or connectivity issues with PGN503
INTERNAL_PROCESSING_ERRORThere is an exception occurred in the checkout which wasn’t handled gracefullyN500
REJECTEDThe transaction is rejected by checkout before creating it.Y200
FAILEDThe transaction failed at PGY200
TRANSACTION_EXPIREDThe redirectUrl of the transaction is expired as user did not access redirect URL of checkout within stipulated time.Y400
DECLINEDRefund is declined by PGY200
TRANSACTION_NOT_FOUNDThe transaction is not foundY400

Webhook Events

Below is the list of valid events which can be subscribed to receive webhook call. For subscription of event(s), these needs to be passed in Create Transaction API.


Event
PROCESSING
AUTHORIZED
AUTHORIZATION_FAILED
AUTHORIZATION_DECLINED
CAPTURED_PARTIALLY
CAPTURED
CANCELLED
PROCESSED
REFUNDED
ALREADY_REFUNDED
FAILED
ABORTED

Payment Methods

Below is the list of available payment methods that are currently supported in checkout. Permitted payment methods may differ across various APIs.

Available Payment Methods
ALL
CARD
SAMSUNGPAY
APPLEPAY