Retrieve Payment

The Retrieve Payment API enables merchants to access detailed information about existing payment transactions. This API, which employs a straightforward GET method, is essential for efficiently fetching transaction data. Such accessibility is crucial for tasks like monitoring transaction statuses, verifying transaction details, and enhancing customer service efforts.

For secure access, this API supports both API key and Basic Authentication methods. Moreover, activation of the "Can View Payment" permission is required for users to operate this API successfully when utilizing Basic Authentication. Detailed guidance on enabling this permission can be found in the View Permission section.

For a thorough understanding of how to implement this API, including necessary details on request and response parameters, please refer to the Request Parameters and Response Parameters sections.

Additionally, to maximize the API’s capabilities and ensure a smooth integration process, merchants are encouraged to explore the Setup section within the Checkout API's main documentation. This section offers comprehensive information on available SDK packages and provides essential insights to streamline the integration process and optimize the use of the Retrieve Payment API.

  • Efficient Data Access: Quickly fetch detailed information on payment transactions without affecting the data's state, ensuring that retrieval is safe and non-disruptive.

  • Enhanced Visibility: Gain comprehensive insights into the specifics of any transaction, facilitating better decision-making and customer support.

  • Ease of Use: Simple and direct access using the GET method, allowing for integration into various backend systems or dashboards for continuous monitoring.

To retrieve the details of a payment transaction, use the same endpoint as the update functionality but with a GET request. Include the session_id as a query parameter to specify the transaction you wish to access:

GET https://<ottu-url>/b/checkout/v1/pymt-txn/?session_id={session_id}

Last updated