Describes the Refund and the Query workflow.

Sandbox Gateway Domain URL:
Production Gateway Domain URL:

Payouts API Reference Overview


Read the Payouts Guides and Tutorials

  • Payouts Product Guide and User Flows
  • Tutorial: Payouts API Workflows

Add Notes

Description: This endpoint is used to register a new payee in the Pockyt system. When you initiate this POST request, you will need to include the necessary payee details. In response, Pockyt will provide a customerNo, which is essential for future transactions and identifies the payee within the system.

Refund API

In the instance where a customer requests a refund, the following request and response objects are initiated to complete the refund workflow.

  • The customer approaches the Point-of-sale manager with a paper receipt or a barcode generated by their digital wallet.
  • The POS manager will scan the barcode or paper receipt by selecting the “refund” button.
  • The Point-of-Sale will use the transaction number to identify the exact details of the original purchase and call Pockyt’s /refund API which will request the digital wallet server to refund the payment originally made by the customer.
  • The wallet server will reimburse the transaction amount to the customer as well as alert the latter about the refund via a notification.

Query API

The /trans-query API is a versatile tool that caters to various payment scenarios, whether it's in the realm of ecommerce or in-store transactions. Its primary purpose is to enable users to retrieve transaction information and perform essential actions such as polling transaction results, researching transactions for potential refunds, or generating custom reports.

Regardless of the payment context, whether it's an online purchase, a point-of-sale transaction, or any other payment scenario, the /trans-query API serves as a robust solution to retrieve and manage transaction information. It empowers businesses to access real-time transaction details, monitor payment statuses, and efficiently handle refund processes. Additionally, it allows users to leverage transaction data for comprehensive reporting and analysis, helping businesses make informed decisions based on valuable insights.