API Documentation
  1. Payin
API Documentation
  • Checkout Page
  • Payin - KRW (Server to Server)
  • Purpose Code
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payout Method
      • Get Required Fields by Payout method
      • Get All Payout Method
    • Payout Beneficiary
      • Create Payout Beneficiary
      • Update Payout Beneficiary
      • Get All Payout Beneficiary
      • Get Payout Beneficiary by Id
      • Validation by Id
      • Validation by Body
    • Payin
      • Create Payin
        POST
      • Simulate Payin
        PATCH
      • Retrieve Payin
        GET
      • Retrieve Payin Memo (PDF)
        GET
      • Create Virtual Account
        POST
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout Memo (PDF)
      • Retrieve Payout
      • Get All Payout
    • Checkout
      • Create Payment Request
      • Get All Checkout
      • Get Detail Checkout
      • Cancel Checkout
      • Get VA Bank Information [KRW]
      • Create New Checkout
    • Transaction
      • Find Transaction by Id
      • Get All Transaction
    • Wallet
      • Create Wallet
      • Get All Wallet
      • Get by Wallet Id
    • Customer
      • Create Customer
      • Update Customer
      • Get All Customer
      • Get Detail Customer by Id
      • Check Is Customer Wallet Ready
      • Enable Customer
      • Disable Customer
      • Delete Customer
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYIN FAILED
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
      • VA Register Callback
    • Get List Payment Method by Currency
      GET
  • Features Documentation
    • Dashboard
    • Transaction
      • Payin
      • Payout
      • Rolling Reserve
      • Refund Request
    • Finance
      • Settlement Report APM
      • Settlement Report CARD
      • History Balance APM
      • History Balance CARD
    • Account
      • Profile Account
      • Manage Users
    • Setting
      • Integration Details
  • Payload Sample
    • Payout Payload Example
  1. Payin

Create Virtual Account

POST
/api/v1/payin/create-va
This API is used to Create Virtual Account before Create Payin using KRW currency. Payin is the primary Method for collecting funds from customers and depositing them into either the customer wallet or the Merchant's Payin wallet.
Each POST/PATCH Request requires a Signature in the header, you can follow the following code to create the Signature:
const crypto = require('crypto');
const signature = crypto.createHmac('sha256', signatureKey) .update(JSON.stringify(data)).digest('hex');

Request

Header Params
X-token
string 
required
Merchant Personal Access Token
Example:
snd_eyJpdiI6IlQxdlRpUGpIaWlyRHZGUUNsV0hMbUE9PSIsInZhbHVlIjoiUFBZTjlhMlhEWFcvTmJuc3hkWWtpbTBScVpDZUVjdVJ0TWMzUDhxMG9EMWFGVUZ0bGFtUzZNb1V6bHoxTTZoMiIsIm1hYyI6IjEzMjc2YTdhNWJhZDBmYWU0YzRiNzgwZTcwYjE3YmE0ZWNlMWI5YmNmOTU1OWZhOTliYzFjZTg5Yzk5MDk4NjEiLCJ0YWciOiIifQ==
signature
string 
required
Hash your string payload request using SHA256, and use your SignatureKey as key
Body Params application/json
customer_full_name
string 
required
payin_method_name
string 
required
account_number
string 
required
account_holder_name
string 
required
currency
string 
required
amount
integer 
required
country
string 
required
Example
{
  "customer_full_name": "Fajar P",
  "payin_method_name": "KDB산업은행",
  "account_number": "112233445",
  "account_holder_name": "Fajar P",
  "currency": "KRW",
  "amount": 128,
  "country": "South Korea"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.paycombat.com/api/v1/payin/create-va' \
--header 'X-token: snd_eyJpdiI6IlQxdlRpUGpIaWlyRHZGUUNsV0hMbUE9PSIsInZhbHVlIjoiUFBZTjlhMlhEWFcvTmJuc3hkWWtpbTBScVpDZUVjdVJ0TWMzUDhxMG9EMWFGVUZ0bGFtUzZNb1V6bHoxTTZoMiIsIm1hYyI6IjEzMjc2YTdhNWJhZDBmYWU0YzRiNzgwZTcwYjE3YmE0ZWNlMWI5YmNmOTU1OWZhOTliYzFjZTg5Yzk5MDk4NjEiLCJ0YWciOiIifQ==' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_full_name": "Fajar P",
    "payin_method_name": "KDB산업은행",
    "account_number": "112233445",
    "account_holder_name": "Fajar P",
    "currency": "KRW",
    "amount": 128,
    "country": "South Korea"
}'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
id
string 
required
merchant_id
string 
required
user_name
string 
required
user_yymmdd
string 
required
account_bankname
string 
required
account_number
string 
required
account_holder
string 
required
status
string 
required
created_at
string 
required
updated_at
string 
required
deleted_at
null 
required
additional_info
null 
required
Example
{
  "status": true,
  "message": "OK",
  "data": {
    "id": "c2fe7846-494f-4852-8ca2-a72499d0002e",
    "merchant_id": "5dc46f8a-4924-4392-967b-81652396a175",
    "user_name": "JOHN DOE",
    "user_yymmdd": "112233",
    "account_bankname": "KRW_BANK_NAME",
    "account_number": "112233445",
    "account_holder": "JOHN DOE",
    "status": "PENDING",
    "created_at": "2025-03-06T05:45:22.000Z",
    "updated_at": "2025-03-06T05:45:22.000Z",
    "deleted_at": null,
    "additional_info": null
  }
}
🟠400Bad Request
Previous
Retrieve Payin Memo (PDF)
Next
Payout