Payment Docs
Card Methods

Type VX

How to make a payment with VX type connected terminal.

Before you start

How to authorize your requests

How to create regular orders

This integration is not available for all merchants. Check availability with your manager.

What's different from a regular order?

For this payment method, you add extra fields in customer, as well as externalUserId. The rest of the fields (amount, currency, successUrl, failUrl, etc.) remain the same as in a regular order creation.

The externalUserId field is required for this payment method.

Additional fields for a regular order

FieldTypeDescription
customerobjectBuyer's data (email, phone, address, etc.)

Requests for each country

Japan 🇯🇵

Customer object fields (Required)

FieldTypeDescription
phonestringPhone number (real), 11 digits starting with 0, without country code (e.g. 09012345678)
emailstringBuyer's email
firstNamestringFirst name in Katakana (must match the phone number owner)
lastNamestringLast name in Katakana (must match the phone number owner)
ipstringPayer's IP (real)

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "externalId": "23456789",
  "externalUserId": "437568",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "JPY",
  "customer": {
    "lastName": "ヤマダ",
    "firstName": "タロウ",
    "email": "john.doe@example.com",
    "phone": "09123456789",
    "ip": "192.168.0.1"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "currency": "JPY",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "23456789",
  "externalUserId": "437568",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Korea 🇰🇷

Customer object fields (Required)

FieldTypeDescription
phonestringPhone number (real), 11 digits starting with 0, without country code (e.g. 09012345678)
emailstringBuyer's email
firstNamestringFirst name in Katakana (must match the phone number owner)
lastNamestringLast name in Katakana (must match the phone number owner)
ipstringPayer's IP (real)
birthdaystringDate of birth (VA only)

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "externalId": "23456789",
  "externalUserId": "437568",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "KRW",
  "customer": {
    "lastName": "abc",
    "firstName": "efg",
    "email": "john.doe@example.com",
    "phone": "01012459077",
    "ip": "192.168.0.1",
    "birthday": "1992-08-15"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "currency": "KRW",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "23456789",
  "externalUserId": "437568",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

India 🇮🇳

Customer object fields (Required)

FieldTypeDescription
phonestringPhone number (real), 10 digits starting with 6, 7, 8, 9
emailstringBuyer's email
firstNamestringFirst name in Katakana (must match the phone number owner)
lastNamestringLast name in Katakana (must match the phone number owner)
ipstringPayer's IP (real)

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "externalId": "23456789",
  "externalUserId": "437568",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "INR",
  "customer": {
    "lastName": "abc",
    "firstName": "efg",
    "email": "john.doe@example.com",
    "phone": "918234567890",
    "ip": "192.168.0.1"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "currency": "INR",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "23456789",
  "externalUserId": "437568",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Philippines 🇵🇭

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "externalId": "23456789",
  "externalUserId": "437568",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "PHP"
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "currency": "PHP",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "23456789",
  "externalUserId": "437568",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Indonesia 🇮🇩

Customer object fields (Required)

FieldTypeDescription
phonestringPhone number (real), 10-13 digits starting with 08 or 628
emailstringBuyer's email
firstNamestringFirst name in Katakana (must match the phone number owner)
lastNamestringLast name in Katakana (must match the phone number owner)

Example request

{
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "externalId": "23456789",
  "externalUserId": "437568",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "callbackUrl": "https://example.com",
  "currency": "IDR",
  "customer": {
    "lastName": "abc",
    "firstName": "efg",
    "email": "john.doe@example.com",
    "phone": "6281245907765"
  }
}

Example response

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "5000",
  "currency": "IDR",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "23456789",
  "externalUserId": "437568",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Type NP

How to make a payment with NP type connected terminal.

Type DL

How to make a payment with DL type connected terminal.

On this page

Before you startWhat's different from a regular order?Additional fields for a regular orderRequests for each countryJapan 🇯🇵Customer object fields (Required)Example requestExample responseKorea 🇰🇷Customer object fields (Required)Example requestExample responseIndia 🇮🇳Customer object fields (Required)Example requestExample responsePhilippines 🇵🇭Example requestExample responseIndonesia 🇮🇩Customer object fields (Required)Example requestExample response