Japan Payment Integration

Before reading this API documentation, be sure to review the API Description Guide

Limits

Transaction Type	Limit
Collection	USD: 0.99-499.99, JPY: 100-150000

Amount Decimal Places: JPY — 0 decimal places (integer only) | USD — 2 decimal places

Collection API

Collection Application

Brief Description:

Create a collection order

URL: /jpy/collect/apply Note: appId for JPY, amount in JPY, settlement in JPY URL: /usd/collect/apply Note: appId for USD, amount in USD, settlement in USD Parameters:

Parameter Name	Required	Type	Description
appId	Yes	Long	Business ID (obtained from backend, must pass corresponding business ID based on currency in URL)
orderId	Yes	String	Merchant order number (must be unique, length not exceeding 48)
name	Yes	String	Recipient name
phone	Yes	String	Real phone number
email	Yes	String	Real email address
amount	Yes	String	Transaction amount (no decimal places allowed)
payType	Yes	String	Refer to Payment Methods
inBankCode	Yes	String	Payment Methods
callBackUrl	Yes	String	URL to redirect after successful payment
callBackFailUrl	Yes	String	URL to redirect after failed payment
cancelUrl	No	String	If provided, the payment page displays a Back button that redirects the user to this URL when clicked.
notifyUrl	No	String	Callback URL
subject	No	String	Payment remark
body	No	String	Remark details
partnerUserId	Yes	String	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 -~!@#$%&*()_.
sign	Yes	String	Signature

request

{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "5000",
  "phone": "09012345678",
  "email": "tanaka.yuki@gmail.com",
  "name": "Tanaka Yuki",
  "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://pay.haipay.asia/cashier/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=="
  }
}

Response data parameter description

Parameter Name	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 Name	Required	Type	Description
appId	Yes	Long	Business ID (obtained from backend, must pass corresponding business ID based on currency in 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=="
  }
}

Response data parameter description

Parameter Name	Type	Description
orderId	String	Merchant order number (must be unique)
orderNo	String	Platform order number
amount	String	Transaction amount
actualAmount	String	Amount received
fee	String	Handling fee
status	Integer	Status (0 - Not started, 1 - In progress, 2 - Success (final), 3 - Failure (final), -1 - Pending confirmation)
payTime	String	Payment success time (present when status=2) (Japan time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure reason (present when status=3)
sign	String	Signature

Payment Methods

Currency	Payment Type (payType)	Payment Code (inBankCode)	Limits	Status	Description
JPY	EWALLET	AU_PAY	100-150000	Available	AuPay
JPY	EWALLET	MERPAY	100-150000	Available	MerPay
JPY	BANK_TRANSFER	GMO_AOZORA	100-150000	Available	GMO Aozora VA
JPY	BANK_TRANSFER	KONBINI_FAMILYMART	300-150000	Available	FamilyMart Convenience Store
JPY	BANK_TRANSFER	KONBINI_LAWSON	300-150000	Available	Lawson Convenience Store
JPY	BANK_TRANSFER	KONBINI_SEVEN_ELEVEN	300-150000	Available	7-Eleven Convenience Store
JPY	BANK_TRANSFER	KONBINI_MINISTOP	300-150000	Available	Ministop Convenience Store
USD	EWALLET	JP_AU_PAY_USD	0.99-499.99	Available	AuPay
USD	EWALLET	JP_MERPAY_USD	0.99-499.99	Available	MerPay
USD	BANK_TRANSFER	JP_GMO_AOZORA_USD	0.99-499.99	Available	GMO Aozora VA
USD	BANK_TRANSFER	JP_KONBINI_FAMILYMART_USD	1.99-499.99	Available	FamilyMart Convenience Store
USD	BANK_TRANSFER	JP_KONBINI_LAWSON_USD	1.99-499.99	Available	Lawson Convenience Store
USD	BANK_TRANSFER	JP_KONBINI_SEVEN_ELEVEN_USD	1.99-499.99	Available	7-Eleven Convenience Store
USD	BANK_TRANSFER	JP_KONBINI_MINISTOP_USD	1.99-499.99	Available	Ministop Convenience Store

Cashier & Unified API

Cards & Components

Subscriptions

Local Payments

Japan Payment Integration

Limits

Collection API

Collection Application

Collection Query

Payment Methods

​Limits

​Collection API

​Collection Application

​Collection Query

​Payment Methods

​Related Topics

Limits

Collection API

Collection Application

Collection Query

Payment Methods

Related Topics