Introduction

The API Reference provides the technical details you need to integrate with Pockyt — endpoint paths, parameters, request/response examples, and error codes. For step-by-step implementation walkthroughs, see the Guides section.

Platform Overview

Pockyt's API platform is organized into four sections, each covering a distinct payment capability:

• Checkout: Accept online payments. Register customers, initiate transactions via SecurePay, process credit cards via Capture, query transaction history, issue refunds, and check balances.

• In-Store: Accept payments at the point of sale through QR code workflows — customer-presented, merchant-presented, or mixed QR codes that support multiple payment methods.

• Payout: Disburse funds to payees. Register payees, set up funding accounts, execute payouts, and manage balances and exchange rates.

• Internal Transfer: Move funds between virtual accounts within the Pockyt platform — typically used by merchant groups and ISVs managing multiple accounts.

Before You Start

👍

Base URLs

All API Reference pages display the production URL by default: https://mapi.yuansfer.com

While in development, change the base URL to the sandbox: https://mapi.yuansferdev.com

📘

Authentication

Every endpoint requires merchantNo, storeNo, and a verifySign parameter signature. See Authentication for details on how to sign requests.

📘

Base URL Variations

Some endpoints use different base paths depending on the API section. See Base URLs and Variances for the full reference table.

Reading the API Reference

Each endpoint page includes:

• Parameters: Every parameter is defined with its type, description, and whether it is required or optional. Required parameters are marked in red next to the parameter name.

• Request Examples: Sample request bodies you can use as starting points for your integration.

• Response Examples: Success and error response samples, including common error patterns and their ret_code values.

For guidance on how endpoints fit together in real integration flows, see the Guides section.