Skip to documentation
YPYakaApp YakaniPay
Menu

API reference

Introduction

API Reference Overview

The API enables client applications to communicate securely with YakaniPay servers using a defined JSON message format. These fields identify the request, operation, merchant, and transaction.

  1. channelName

    Identifies the request origin, such as WEB.

  2. serviceName

    Defines the requested operation: API_PURCHASE, API_CANCELPURCHASE, API_PREAUTHORIZE, API_PREAUTHORIZE_COMMIT, or API_PREAUTHORIZE_CANCEL.

  3. serviceParams

    Contains merchantUid, apiUserId, apiKey, paymentMethod, referenceId, and description.

  4. referenceId

    A unique merchant order or transaction identifier used to prevent duplicates and support accurate tracking.

Decimal precision policy

Amounts may have up to two decimal places. Values with more than two decimal places are truncated—not rounded—during processing.

Valid1010.210.23
Automatically truncated10.237 → 10.2399.999 → 99.99

Sandbox and production endpoints

Sandboxhttps://sandbox.yakanipay.com/asm
Productionhttps://api.yakanipay.net/asm

Response codes

CodeNameDescription
2001RCS_SUCCESSRequest processed successfully
5301RCS_INVALID_HPPKEYIncorrect API credentials
5302RCS_INVALID_HPPTOKENInvalid HPP token
5303RCS_INVALID_HPPRESULTTOKENInvalid HPP result token
5304RCS_HPP_MERCHANT_REFERENCEID_MISMATCHTransaction reference mismatch
5305RCS_HPP_REQUESTID_MISMATCHTransaction request ID mismatch
5306RCS_HPP_USERACTION_CANCELLEDCustomer cancelled the transaction
5307RCS_HPPTOKEN_EXPIREDHPP token expired
5308RCS_HPP_SUBSCRIPTION_ISNOT_ENABLEDMerchant is not enabled for this service
5309RCS_HPP_USERACTION_TIMEOUTCustomer did not complete the transaction within five minutes