Skip to main content

Response Structure

The error field is not a fixed contract:
  • Meaning varies by response source:
    • API responses: on failure, status="0" and error carries the corresponding error code (see the scenario sections on this page);
    • Merchant console and checkout page responses: on failure, only status is "0" while error remains 00000000 (identical to the success value), with the message text in msg;
    • Order outcomes: when an order fails, the query API still returns status="1" and error="00000000", with the actual outcome in data.status and data.errorMsg
  • Subject to change at any time: error codes and messages may be added, adjusted, or change meaning in any release; do not use error code values or msg texts directly to determine business outcomes.
Success Response
Failure Response (missing a required parameter)

Error Code Overview

Errors by Scenario

Signature, Authentication & Access

Signature Failure Example

Merchant Capability & Onboarding Status

Missing Required Parameters

Provide the missing required field(s) and retry. Field names depend on the specific API.

Invalid Parameter Format

The field format, length, or value does not meet requirements. Correct it per the field rules on the corresponding API page.

Amount & Limits

Amount Limit Exceeded Example

Recipient Account Info (Disbursement)

Key & Encryption Configuration

Exchange Rate Query

Payment Method & Bank Code

Application (appId)

System Busy & Processing Timeout

Voucher / PDF Generation

Subscription

Refunds

Balance & Deductions

Reconciliation Files

Global Cashier

Merchant Console Common Errors

The messages in this section appear when signing in to and operating the merchant console (they are not API response payloads). Follow the descriptions below; if the issue persists, contact HaiPay support with the message and error code. Codes here are console-service codes, a separate system from API error codes (1001/1002…); — means the message carries no discriminating code.

Login & Session

Security Verification (MFA & Codes)

Password Management

Sub-accounts & Permissions

Batch Payout & Vouchers

Files & Export Center

Console Preferences

Others

Checkout Page Common Errors

Errors in this section are shown on the checkout / payment link / redirect payment pages and are seen by your customers (they are not API responses). These errors carry no dedicated error code: in JSON responses only status is 0 on failure while error remains 00000000 (identical to the success value), with the message text in msg; some redirect pages output plain text directly. If they persist, contact HaiPay support with the message and order number.

Orders and Subscriptions

Risk Control and Exchange Rate

Information Collection and KYC

Card Payment

Redirect Pages

Order Failure Reason (data.errorMsg)

In the data of collection and disbursement order query APIs, besides the order status (a number), there is an errorMsg field representing the original failure reason of that order. This field describes the order’s own processing result and may contain text returned by the bank or the recipient. Determine the order result from data.status and handle accordingly; if you need help, contact HaiPay support with the orderNo.
Do not treat data.errorMsg as the API call result. The success or failure of the API call is determined by the top-level status and error; data.errorMsg describes the order’s business-level processing result. They are at different layers.
Last modified on October 15, 2026