get
https://sandboxapi.upayments.com/api/v1/get-payment-status/
This API is designed to retrieve the status and details of a previously initiated transaction. Its primary function is to allow the client to update their internal transaction records with the most current information.
Rate Limiting Policy
To ensure system stability and fair usage, clients are restricted to a maximum of 30 requests per minute to this endpoint. If this rate limit is exceeded, the client's access will be temporarily blocked from making further requests. Please implement appropriate retry logic with exponential backoff on your side.
Usage - Three Ways to Check Status
The get-payment-status API can be utilized in three different ways, depending on the unique identifier you have available:
- By
track_id(URL Path Parameter) Thetrack_idis a unique identifier generated for every transaction attempt.- How to get the
track_id: It can be fetched from the redirect URLs (returnUrl, cancelUrl) or received via the Notification Webhook. - API Endpoint Format: The merchant should pass the
track_iddirectly as a URL Path Parameter.
- How to get the
- By
session_id(Query Parameter) Thesession_idis a system-generated identifier for the transaction session.- How to get the
session_id: It can be fetched from the reponse of the charge request. - API Endpoint Format: The merchant should pass the
session_idas a Query Parameter.
- How to get the
- By
invoice_id(Query Parameter) This method is specifically used for transactions initiated via thecreate-invoiceChargeAPI- How to get the
encrypted_invoice_id: Theencrypted_invoice_idis returned in the response of thecreate-invoiceAPI. - API Endpoint Format: The merchant should pass the
encrypted_invoice_idas a Query Parameter.
- How to get the
