Skip to main content
POST
SGD Collection Application
All example requests on this page are based on the sandbox (test) environment. Please be careful to distinguish it from the production environment.

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer
required

Business ID (retrieved from backend; must use the corresponding business ID)

orderId
string
required

Merchant order number

Maximum string length: 48
name
string
required

User's full name, recommended to use real name. Format: firstName + lastName separated by a space, e.g. John Doe

phone
string
required

Valid phone number

email
string<email>
required

Valid email address

amount
string
required

Transaction amount, up to 2 decimal places

Pattern: ^\d+\.?\d{0,2}$
payType
string
required

Transaction type

inBankCode
string
required
callBackUrl
string<uri>
required

Redirect URL after successful payment

callBackFailUrl
string<uri>
required

Redirect URL after failed payment

partnerUserId
string
required

Unique user identifier (e.g., userId). Must be valid for risk control; otherwise transactions may be affected. Allowed format: numbers, letters, or symbols -~!@#$%&*()_.

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
sign
string
required

Signature

notifyUrl
string<uri>

Callback URL

subject
string

Payment note

body
string

Additional description

Response

200 - application/json
status
string

1: Normal, 0: Exception

error
string

Error code

msg
string

Error description

data
object
Last modified on October 13, 2026