Warning

Before reading this API documentation, please make sure to check API Description Guide

Collection API

Collection Request

Brief Description:

• Create a collection order

URL：/jpy/collect/apply
Note: appId JPY, amount JPY, settlement JPY

URL：/usd/collect/apply
Note: appId USD, amount USD, settlement USD

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from backend, must pass the corresponding business ID according to currency in URL)
orderId	Yes	String	Merchant order number (must be unique, max length 48)
name	Yes	String	Payer’s name
phone	Yes	String	Real phone number
email	Yes	String	Real email
amount	Yes	String	Transaction amount (no decimals allowed)
payType	Yes	String	Refer to Payment Methods
inBankCode	Yes	String	Refer to Payment Methods
callBackUrl	Yes	String	Redirect URL after successful payment
callBackFailUrl	Yes	String	Redirect URL after failed payment
notifyUrl	No	String	Notification callback URL
subject	No	String	Payment note
body	No	String	Detailed remark
partnerUserId	Yes	String	Unique user identifier (e.g. userId). Used for risk control, must be valid, otherwise transactions may be affected. Format: numbers, letters, or symbols -~!@#$%&*()_.
sign	Yes	String	Signature

request

{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "300",
  "phone": "09230219312",
  "email": "23423@qq.com",
  "name": "test",
  "inBankCode": "PH_QRPH_DYNAMIC",
  "payType": "QR",
  "partnerUserId": "149597870",
  "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M233323000059",
    "orderNo": "6023071013539074",
    "payUrl": "https://a.api-uat.php.com/1L9zQS2",
    "bankCode": "GCASH_STATIC_VA",
    "bankNo": "PC0007I10000035",
    "qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
    "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
  }
}

Return Data Parameters

Parameter	Type	Description
orderId	String	Merchant order number (must be unique)
orderNo	String	Platform order number
payUrl	String	Payment link
sign	String	Signature

Collection Query

Brief Description:

• Query collection order

URL：/jpy/collect/query

URL：/usd/collect/query

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from backend, must pass the corresponding business ID according to currency in the URL)
orderId	Yes	String	Merchant order number
orderNo	No	String	Platform order number (faster response)
sign	Yes	String	Signature

request

{
  "appId": 1054,
  "orderId": "M22222000028",
  "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M22222000028",
    "orderNo": "6023042811314347",
    "amount": "50000.00",
    "actualAmount": "0.00",
    "fee": "0.00",
    "status": 1,
    "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
  }
}

Return Data Parameters

Parameter	Type	Description
orderId	String	Merchant order number (must be unique)
orderNo	String	Platform order number
amount	String	Transaction amount
actualAmount	String	Received amount
fee	String	Fee
status	Integer	Status (0 = Not started, 1 = Processing payment, 2 = Success [final], 3 = Failed [final], -1 = Exception pending confirmation)
payTime	String	Payment success time (value exists when status = 2) (Japan Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure reason (value exists when status = 3)
sign	String	Signature

Payment Methods

JPY Orders

payType	inBankCode	Limit	Description
EWALLET	AU_PAY	100-150000	AuPay
EWALLET	MERPAY	100-150000	MerPay
BANK_TRANSFER	KONBINI_FAMILYMART	300-150000	FamilyMart
BANK_TRANSFER	KONBINI_LAWSON	300-150000	Lawson
BANK_TRANSFER	KONBINI_SEVEN_ELEVEN	300-150000	7-Eleven
BANK_TRANSFER	KONBINI_MINISTOP	300-150000	Ministop

USD Orders

payType	inBankCode	Limit	Description
EWALLET	JP_AU_PAY_USD	0.99-1000	AuPay
EWALLET	JP_MERPAY_USD	0.99-1000	MerPay
BANK_TRANSFER	JP_KONBINI_FAMILYMART_USD	1.99-1000	FamilyMart
BANK_TRANSFER	JP_KONBINI_LAWSON_USD	1.99-1000	Lawson
BANK_TRANSFER	JP_KONBINI_SEVEN_ELEVEN_USD	1.99-1000	7-Eleven
BANK_TRANSFER	JP_KONBINI_MINISTOP_USD	1.99-1000	Ministop