Checkout APIs

The Checkout APIs power Pockyt's online payment acceptance. Use these endpoints to register customers, initiate payments, query transaction history, process refunds, and check merchant balances.

What You'll Find in This Section

  • Customer Management: Register customers and retrieve customer profiles. Every checkout flow starts by creating a customerNo through the Register Customer endpoint, which is then referenced in payment requests.

  • SecurePay API: The core payment initiation endpoint. SecurePay supports multiple integration styles — hosted checkout pages, whitelabel checkout (YIP), and recurring payments — all through the same endpoint with different terminal parameter values.

  • Capture: Sends credit card information directly to Pockyt to process a transaction.

  • Queries and Reporting: Retrieve individual transaction details, query bulk transaction history, add notes to transactions, and check settlement status.

  • Refund: Process full or partial refunds against completed transactions.

  • Balance: Retrieve your merchant account balance.

📘

Where to start: If you're integrating Pockyt for the first time, begin with Register Customer and then SecurePay API. For step-by-step integration walkthroughs, see the Guides section.

⚠️

Authentication: All endpoints require merchantNo, storeNo, and a verifySign parameter signature. See Authentication for details on signing requests.