Skip to main content
POST
/
jpy
/
collect
/
apply
JPY Collection Application
curl --request POST \
  --url https://uat-interface.haipay.asia/jpy/collect/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": 123,
  "orderId": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "amount": "<string>",
  "payType": "<string>",
  "inBankCode": "<string>",
  "callBackUrl": "<string>",
  "callBackFailUrl": "<string>",
  "partnerUserId": "<string>",
  "sign": "<string>",
  "notifyUrl": "<string>",
  "subject": "<string>",
  "body": "<string>"
}
'
{
  "status": "<string>",
  "error": "<string>",
  "msg": "<string>",
  "data": {
    "orderId": "<string>",
    "orderNo": "<string>",
    "payUrl": "<string>",
    "sign": "<string>"
  }
}

Secret Key & Private Key (Generate Signature)

Body

application/json
appId
integer
required

Business ID (obtained from backend, must pass corresponding business ID based on currency in URL)

orderId
string
required

Merchant order number

Maximum string length: 48
name
string
required

Recipient name

phone
string
required

Real phone number

email
string<email>
required

Real email address

amount
string
required

Transaction amount (no decimal places allowed)

Pattern: ^\d+$
payType
string
required
inBankCode
string
required
callBackUrl
string<uri>
required

URL to redirect after successful payment

callBackFailUrl
string<uri>
required

URL to redirect after failed payment

partnerUserId
string
required

Unique user identifier (e.g., userId), used for risk control, must be real and valid, otherwise it will affect transactions. Format requirements: digits, uppercase and lowercase letters or common symbols -~!@#$%&*()_.

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

Signature

notifyUrl
string<uri>

Callback URL

subject
string

Payment remark

body
string

Remark details

Response

200 - application/json
status
string

1: Normal, 0: Exception

error
string

Error code

msg
string

Error description

data
object
Last modified on April 10, 2026