Sandbox Gateway Domain URL: https://mapi.yuansferdev.com
Production Gateway Domain URL: https://mapi.yuansfer.com

📘

Additional Resources

• Pockyt In-Store Payments Solution Guide - A general introduction to the solutions, the scenarios and entities involved.
• In-Store API References - Detailed explanations of the API endpoints, parameters, responses and requirements for each call.

Important API Endpoints

Create QR Code API

• Use Case: Customer Scans a Merchant Presented QR Code
• Method: POST
• Endpoint: https://mapi.yuansfer.com/app-instore/v3/create-trans-qrcode

Description: This API allows merchant POS systems to generate QR codes with unique transaction numbers from the Pockyt system. When customers scan these QR codes using their mobile digital wallet apps, they can access payment URLs, transaction numbers, and transaction details sent by the Merchant POS system. Essentially, it simplifies the process of creating QR codes and transaction numbers for customers to initiate payments through their digital wallet apps.

Create New Transaction API

• Use Case: Merchant Scans a Customer Presented QR Code
• Method: POST
• Endpoint: https://mapi.yuansfer.com/app-instore/v3/add

Description: This API enables the merchant's POS system to generate a distinct transaction number, which will play a crucial role after the customer presents their payment barcode. This transaction number gets linked to the payment, and the merchant POS system can also assign its own reference number, which will be associated with the transaction number generated by Pockyt. This reference number can be used later for inquiries and reporting purposes. In essence, it facilitates the creation of a transaction object and provides customers with a transaction number to initiate their payments.

Process Payment API

• Use Case: Merchant Scans a Customer Presented QR Code
• Method: POST
• Endpoint: https://mapi.yuansfer.com/app-instore/v3/prepay

Description: This API serves as a means for the Merchant's POS system to verify and execute payments via digital wallet networks. To do so, the Merchant's POS must transmit both the transaction number obtained from the prior "/add" API call and the payment barcode value generated when the customer scans their digital wallet.

Cancel Payment API

• Use Case: Both Customer Scan and Merchant Scan Scenarios
• Method:: POST
• Endpoint: https://mapi.yuansfer.com/app-data-search/v3/cancel

Description: This API enables the Merchant's POS system to trigger a cancellation notification for a transaction, especially when a customer abandons the process or when the cashier needs to initiate a cancellation instruction after the initial transaction number has been generated. Its primary purpose is to facilitate the cancellation of payment transactions in cases where the transaction is abandoned before final submission.