API Documentation
  1. Payout Method
API Documentation
  • API Reference Guide
    • Checkout Page
    • Payin - KRW (Server to Server)
    • Purpose Code
    • Payout Payload Example
    • List of Payin Methods
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payout Method
      • Get Required Fields by Payout method
        GET
      • Get All Payout Method
        GET
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin 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
      • 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
      • Cancel Checkout
      • Get Detail Checkout
      • Create Virtual Account [KRW]
      • 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 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
  1. Payout Method

Get All Payout Method

GET
/api/v1/payout-method
This API is used to retrieve a list of Payout-Methods available. The parameters will be SENDER and BENEFICIARY objects and other required fields to be provided for both parties. You can filter the results by specifying the currency and country query parameters.

Request

Query Params
sender_country
string 
required
Example:
KR
sender_currency
string 
required
Example:
KRW
beneficiary_country
string 
required
Example:
KR
beneficiary_currency
string 
required
Example:
KRW
payout_method_class
string  | null 
optional
DOMESTIC || GCA
Header Params
X-token
string 
required
Example:
snd_eyJpdiI6Ik41YjZiWXFPQnR4RkxEN2xaQmgybkE9PSIsInZhbHVlIjoiMEErazkwaDlicjFFWHlzd0lkTi9VQjRJOGFOZjgrSzhVQllvamhTaUFVMVU4SVJhM1EzdzdVdlpCK2dZMXhOSyIsIm1hYyI6IjI0OWE5NzUxYjE0MDMyNTY0YWVmOTlkYzdmOGIyOGVkMzg1YWYzNDk2YTdjYjMwODRiY2NlM2UxMjM5NTJmZmUiLCJ0YWciOiIifQ==

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 GET 'https://api.paycombat.com/api/v1/payout-method?sender_country=KR&sender_currency=KRW&beneficiary_country=KR&beneficiary_currency=KRW&payout_method_class=' \
--header 'X-token: snd_eyJpdiI6Ik41YjZiWXFPQnR4RkxEN2xaQmgybkE9PSIsInZhbHVlIjoiMEErazkwaDlicjFFWHlzd0lkTi9VQjRJOGFOZjgrSzhVQllvamhTaUFVMVU4SVJhM1EzdzdVdlpCK2dZMXhOSyIsIm1hYyI6IjI0OWE5NzUxYjE0MDMyNTY0YWVmOTlkYzdmOGIyOGVkMzg1YWYzNDk2YTdjYjMwODRiY2NlM2UxMjM5NTJmZmUiLCJ0YWciOiIifQ=='

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
array [object {18}] 
required
payout_method_id
string 
optional
payout_method_name
string 
optional
payout_method_description
string 
optional
payout_method_logo
string 
optional
sender_country
string 
optional
sender_currency
string 
optional
beneficiary_country
string 
optional
beneficiary_currency
string 
optional
payout_method_category
string 
optional
payout_method_class
string 
optional
payout_method_group
string 
optional
min_amount
integer 
optional
max_amount
integer 
optional
is_returnable
boolean 
optional
is_enabled
boolean 
optional
limit
integer 
optional
page
integer 
optional
status
string 
optional
Examples
{
    "status": true,
    "message": "string",
    "data": [
        {
            "payout_method_id": "string",
            "payout_method_name": "string",
            "payout_method_description": "string",
            "payout_method_logo": "string",
            "sender_country": "string",
            "sender_currency": "string",
            "beneficiary_country": "string",
            "beneficiary_currency": "string",
            "payout_method_category": "string",
            "payout_method_class": "string",
            "payout_method_group": "string",
            "min_amount": 0,
            "max_amount": 0,
            "is_returnable": true,
            "is_enabled": true,
            "limit": 0,
            "page": 0,
            "status": "string"
        }
    ]
}
🟠400Bad Request
Modified at 2025-05-06 02:20:52
Previous
Get Required Fields by Payout method
Next
Get All Payin Method