Request virtual account API

Requests a virtual account for payment collection from the customer.

Supported PGs

  • Settlebank
  • NICE Payments
  • KG INCIS

Key request parameter description

vbank_code * String

Bank code

Bank codes by PG

pg * string

pg code

This is required when there are multiple API method, non-authenticated PG settings in the Admin console.

If there are multiple MID settings for the same PG, specify as:

{PG}.{PG Merchant ID}

If this is unspecified or set to an invalid value, the default PG is used.

  • If there are 2 PG settings, NICE Payments and JTNet, specify as nice or jtnet.
  • If you have multiple MIDs from NICE Payments, specify as nice.MID1 or nice.MID2.

notice_url String

Deposit notification URL

When a payment is deposited into a virtual account, if this URL is not specified, the notification URL setting in the Admin console is used.

custom_data json

Custom data

If set with an object, this is saved as JSON string.

pg_api_key String

API Key

This is the API Key from the KG INICIS Merchant console and is used for virtual account issuance and cancellation. A hashData mismatch error occurs if you specify a missing or invalid key.

(Required for KG INICIS only)