v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payments

Create a payment order

Create a payment order. Integration Methods:

  1. API-ONLY Integration 1.1 Card Payments 1.1.1 Hosted Mode (Supports full hosted/embedded mode) 1.1.2 Server-to-Server Mode
  2. Checkout Page Integration (Supports full hosted mode, embedded mode not supported yet) 2.1 Create checkout session (Customers choose payment method themselves) 2.2 Pre-selected payment method

Payment Method Value and ID Mapping:

  • CARD:(100002)
  • CRYPTO_CARD:(100003)
  • USDC:(100007)
  • USDT:(100008)
post/open-api/v3/acquiring/payments

Request body

merchantTradeNostring required

Merchant-generated order number, globally unique/idempotent

amountstring required

Order amount in string format, up to 6 decimal places

currencystring required

Order currency

countrystring required

Order country

descriptionstring

Merchant-provided information, will be returned as-is

Example request

{
  "merchantTradeNo": "ORDER20250814123456",
  "amount": "99.99",
  "currency": "USD",
  "country": "US",
  "paymentDetail": {
    "paymentMethod": "CARD",
    "integrationMode": "redirect"
  },
  "callbackUrls": {
    "success": "https://merchant.com/success",
    "fail": "https://merchant.com/fail",
    "notify": "https://merchant.com/notify"
  },
  "returnUrls": {
    "successUrl": "https://merchant.com/success",
    "failUrl": "https://merchant.com/fail"
  },
  "card": {
    "firstName": "John",
    "lastName": "Doe",
    "pan": "4111111111111111",
    "expireMonth": "12",
    "expireYear": "2025",
    "cvv": "123"
  },
  "customer": {
    "merchantCustomerId": "CUST001",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "+1234567890"
  },
  "goods": [
    {
      "name": "Product Name",
      "sku": "SKU123",
      "quantity": 1,
      "price": "99.99",
      "totalAmount": "99.99"
    }
  ],
  "shippingInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "shippingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "addressLine1": "123 Main St",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postalCode": "10001"
    }
  },
  "billInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "billAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "addressLine1": "123 Main St",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postalCode": "10001"
    }
  },
  "merchant": {
    "subMerchantId": "1814008790800"
  },
  "additionalInfo": {
    "transferReference": "TRANSFER123"
  },
  "description": "Additional order information"
}

Response

OK

codeinteger

Return code

messagestring

Error message