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) The track_id is 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_id directly as a URL Path Parameter.

Method	Endpoint Format	Example
GET	https://sandbox.upayments.com/api/v1/get-payment-status/{track_id}	https://sandbox.upayments.com/api/v1/get-payment-status/019ae3cc7da914644b7efd5638cdc83fv2

By session_id (Query Parameter) The session_id is 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_id as a Query Parameter.

Method	Endpoint Format	Example
GET	https://sandbox.upayments.com/api/v1/get-payment-status?session_id={session_id}	https://sandbox.upayments.com/api/v1/get-payment-status?session_id=2025133235031228373483523989923251714885916179872

By invoice_id (Query Parameter) This method is specifically used for transactions initiated via the create-invoice Charge API
- How to get the encrypted_invoice_id: The encrypted_invoice_id is returned in the response of the create-invoice API.
- API Endpoint Format: The merchant should pass the encrypted_invoice_id as a Query Parameter.

Method	Endpoint Format	Example
GET	https://sandbox.upayments.com/api/v1/get-payment-status?invoice_id=encrypted_invoice_id	https://sandbox.upayments.com/api/v1/get-payment-status?invoice_id=R9kA7oMzL4

201201

404404