Virtual Account

How to use VirtualAccount to submit a payin in South Korea.

Payin by Wallet

POST https://gateway-test.pagsmile.com/trade/pay

This endpoint allows you to submit a payin by VirtualAccount in South Korea.

Headers

Name

Type

Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name

Type

Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

notify_url*

string

Where Pagsmile will send notification to

return_url

string

Redirect to Merchant's url when user finished checkout

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

method*

string

Fixed value: VirtualAccount

order_amount*

string

payment amount - 500 ~ , Only integerr -

order_currency*

string

Fixed value: KRW

subject*

string

payment reason or item title

- Max. 128 chars -

content

string

payment reason detail or item detail

- Max. 255 chars -

buyer_id*

string

merchant user's id

customer.name*

string

User's name

customer.email*

string

User's email

customer.phone*

string

User's phone

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354006",
    "web_url": "",
    "trade_status": "PROCESSING",
    "pay_url":"https://checkout.pagsmile.com/checkout?prepay_id=" //The pay_url can only be opened once.
}

{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "out_trade_no": "202201010354006",
    * "method": "VirtualAccount",
    * "order_amount": "2000",
    * "order_currency": "KRW",
    * "subject": "trade pay test",
    "content": "trade pay test content",
    * "notify_url": "http://merchant/callback/success",
    "return_url": "https://www.merchant.com",
    * "buyer_id": "buyer_0101_0001",
    * "timestamp": "2022-01-01 03:54:01",
    * "customer": {
    *     "name": "Test User Name",
    *     "email": "test@pagsmile.com",
    *     "phone": "8210***4"
      }
      }'

Note: 162************38 is pagsmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Please use your own app_id and generate your own authorization token when testing.

PreviousBank Transfer NextSingapore

Last updated 3 months ago

Was this helpful?

Payin by Wallet

POST https://gateway-test.pagsmile.com/trade/pay

This endpoint allows you to submit a payin by VirtualAccount in South Korea.

Headers

Name

Type

Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name

Type

Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

notify_url*

string

Where Pagsmile will send notification to

return_url

string

Redirect to Merchant's url when user finished checkout

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

method*

string

Fixed value: VirtualAccount

order_amount*

string

payment amount - 500 ~ , Only integerr -

order_currency*

string

Fixed value: KRW

subject*

string

payment reason or item title

- Max. 128 chars -

content

string

payment reason detail or item detail

- Max. 255 chars -

buyer_id*

string

merchant user's id

customer.name*

string

User's name

customer.email*

string

User's email

customer.phone*

string

User's phone

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354006",
    "web_url": "",
    "trade_status": "PROCESSING",
    "pay_url":"https://checkout.pagsmile.com/checkout?prepay_id=" //The pay_url can only be opened once.
}

{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "out_trade_no": "202201010354006",
    * "method": "VirtualAccount",
    * "order_amount": "2000",
    * "order_currency": "KRW",
    * "subject": "trade pay test",
    "content": "trade pay test content",
    * "notify_url": "http://merchant/callback/success",
    "return_url": "https://www.merchant.com",
    * "buyer_id": "buyer_0101_0001",
    * "timestamp": "2022-01-01 03:54:01",
    * "customer": {
    *     "name": "Test User Name",
    *     "email": "test@pagsmile.com",
    *     "phone": "8210***4"
      }
      }'

Please use your own app_id and generate your own authorization token when testing.