Skip to content

PayIn API Overview

This section lists the base fields for PayIn order creation and create-and-pay.

Base fields (CreatePayInOrderCmd)

FieldRequiredDescription
merchantOrderNoYesMerchant order number (idempotent)
amountYesOrder amount, minimum 0.01
currencyYesCurrency
productNameNoProduct name
productDescNoProduct description
billingAddressNoBilling address (see Address Structure)
shippingAddressNoShipping address (see Address Structure)
remarkNoRemark
returnUrlNoSync redirect URL (lower priority than merchant config)
extParamsNoExtended parameters (JSON)
lineItemsNoOrder line items (see LineItem Structure)

createAndPay fields (CreatePayInOrderAndPayCmd)

FieldRequiredDescription
methodCodeYesPayment method code (e.g., INTERNATIONAL_CARD)
methodDataYesPayment method data (depends on methodCode)

See the payMethod docs for method-specific fields.