Skip to main content

Card Payments

Card Payment

POST/pay_index

Initiate a card payment transaction.

Bodyapplication/x-www-form-urlencoded

pay_memberidstringrequiredsign

Merchant ID assigned by the platform.

pay_orderidstringrequiredsign

Unique order ID generated by the merchant.

pay_applydatestring, format: 2016-12-26 18:18:18requiredsign

Order submission timestamp.

pay_bankcodestringrequiredsign

Payment method bank code. See the table below.

pay_notifyurlstringrequiredsign

Webhook URL for server-side payment notifications (POST).

pay_callbackurlstringrequiredsign

Return URL where the customer is redirected after payment (GET).

pay_amountstringrequiredsign

Transaction amount.

pay_md5signstringrequired
pay_currencystringrequired

Three-letter ISO 4217 currency code in uppercase (e.g., USD).

pay_urlstringrequired

Merchant website URL (subject to review). Must include the http:// or https:// scheme.

pay_cardnostring

Card number (PAN).

pay_cardmonthstring, two digits, e.g. 02

Card expiration month.

pay_cardyearstring, four digits, e.g. 2023

Card expiration year.

pay_cardcvvstring

Card verification value (CVV).

pay_productnamestringrequired

Product line items as a JSON array string. Field names are case-sensitive. Example: [{"sku":"123456789","productName":"Mac Book Pro","productImage":"url","attributes":"Size:US8 Color:blue","price":"11000.00","quantity":"1"}]

pay_productname.skustring

Product SKU (unique identifier).

pay_productname.productNamestringrequired

Product name.

pay_productname.productImagestring

Product image URL.

pay_productname.attributesstring

Product attributes (e.g., size and color).

pay_productname.pricestringrequired

Unit price.

pay_productname.quantitystringrequired

Quantity.

pay_firstnamestringrequired

Cardholder billing first name.

pay_lastnamestringrequired

Cardholder billing last name.

pay_country_iso_code_2stringrequired

Billing country code (ISO 3166-1 alpha-2).

pay_email_addressstringrequired

Billing email address.

pay_telephonestringrequired

Billing phone number.

pay_country_iso_code_2stringrequired

Billing country code (ISO 3166-1 alpha-2).

pay_street_address1string

Billing address line 1.

pay_street_address2string

Billing address line 2.

pay_citystring

Billing city.

pay_postcodestring

Billing postal code.

pay_statestring

Billing state or province.

pay_email_addressstringrequired

Billing email address.

pay_telephonestringrequired

Billing phone number.

One of:
pay_ipstringrequired

Customer IP address.

pay_useragentstringrequired

Customer browser User-Agent string.

pay_languagestring

Customer preferred language or locale code.

systemstring

E-commerce platform name (e.g., Shopyy, Shopline).

Response

statusint

Transaction status: 0 - success; 1 - 3DS authentication required; 2 - failed.

msgstring

Result message describing the transaction outcome.

urlstring

3DS redirect URL. Returned when status is 1.