API Documentation
  1. API Documentation
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
      • Simulate Payin
      • Retrieve Payin
      • Retrieve Payin Memo (PDF)
      • Create Virtual Account
    • 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. API Documentation

Payout

To perform a payout, please follow the standard flow below.
If the beneficiary details are expected to remain the same across multiple payouts, we recommend using the Payout Beneficiary API. This approach helps simplify the process by allowing you to:
Register and store beneficiary information in advance.
Reuse the beneficiary_id in future payout requests.
Reduce the need to send full beneficiary details with every transaction.

Without Create Payout Beneficiary API Step#

1
List Payout Method
To get a list of available payout methods based on the supported currency and your merchant configuration, use the following endpoint. Select one of the payment_method_payout values returned in the response. This value should be used in the next step when initiating the payout request.
Get List Payment Method by Currency
2
Get Required Fields by Payout method
This API is used to retrieve the required parameters for a specific Payout-Method.The parameters returned could be both SENDER and BENEFICIARY objects.
Get Required Fields by Payout method
3
Create Payout
This API is used to Create Payout and Sending Funds to the Beneficiary.
Create Payout

With Create Payout Beneficiary API Step#

1
List Payout Method
To get a list of available payout methods based on the supported currency and your merchant configuration, use the following endpoint. Select one of the payment_method_payout values returned in the response. This value should be used in the next step when initiating the payout request.
Get List Payment Method by Currency
2
Get Required Fields by Payout method
This API is used to retrieve the required parameters for a specific Payout-Method.The parameters returned could be both SENDER and BENEFICIARY objects.
Get Required Fields by Payout method
3
Create New Payout Beneficiary
This API is used to Create Payout Beneficiary for Payout transaction. The required parameters for the payout beneficiary request will vary depending on the currency and the selected payment method payment_method_payout. And please note that the Beneficiary will be activated after 24 hours of creation.
Create Payout Beneficiary
4
Payout Beneficiary Validation (Optional)
After successfully creating a payout beneficiary, you can validate the beneficiary using the beneficiary_id and the request body.
Validation by Id
Validation by Body
5
Create Payout with Beneficiary ID
Once the beneficiary has been successfully activated, you can proceed to initiate a payout by referencing the Beneficiary Id.
Create Payout
Previous
Create Virtual Account
Next
Create Payout