API Documentation
  1. Payout Beneficiary
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 All Payout Method
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payout Beneficiary
      • Create Payout Beneficiary
        POST
      • Update Payout Beneficiary
        PATCH
      • Get All Payout Beneficiary
        GET
      • Get Payout Beneficiary by Id
        GET
      • Validation by Id
        POST
      • Validation by Body
        POST
    • 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 Beneficiary

Validation by Body

POST
/api/v1/payout-beneficiary/validation-by-body/{payout_method_name}
This API is used to validate beneficiary details using the Payout_method_name and request body.
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

Path Params
payout_method_name
string 
required
Header Params
X-token
string 
required
signature
string 
required
Hash your string payload request using SHA256, and use your Merchantid+Token as key
Body Params application/json
type
enum<string> 
required
Allowed values:
COMPANYINDIVIDUAL
company
object 
required
address_city
string 
optional
address_country
string 
optional
address_line1
string 
optional
address_line2
string 
optional
address_state
string 
optional
address_zip_code
integer 
optional
company_email
string 
optional
incorporation_country
string 
optional
name
string 
required
phone_country_code
string 
optional
phone_number
string 
optional
registration_number
string 
optional
individual
object 
required
address_city
string 
optional
address_country
string 
optional
address_line1
string 
optional
address_line2
string 
optional
address_state
string 
optional
address_zip_code
string 
optional
country_of_residence
string 
optional
dob
string 
optional
email
string 
optional
first_name
string 
required
last_name
string 
required
identification_custom_type
string 
optional
identification_type
string 
optional
identification_value
string 
optional
nationality
string 
optional
phone_country_code
string 
optional
phone_number
string 
optional
aba
string 
optional
account_number
string 
optional
bank_code
string 
optional
bank_country
string 
optional
bank_name
string 
optional
beneficiary_name
string 
required
bic_swift
string 
optional
intermediary_bic_swift
string 
required
branch_code
string 
optional
bsb
string 
optional
currency
string 
optional
description
string 
optional
iban
string 
optional
ifsc
string 
optional
organization_reference_id
string 
optional
pay_id
string 
optional
pay_id_type
string 
optional
sort_code
string 
optional
metadata
object 
optional
Example
{
    "type": "company",
    "company": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": 0,
        "company_email": "string",
        "incorporation_country": "string",
        "name": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "registration_number": "string"
    },
    "individual": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "dob": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "identification_custom_type": "string",
        "identification_type": "string",
        "identification_value": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    },
    "aba": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_country": "string",
    "bank_name": "string",
    "beneficiary_name": "string",
    "bic_swift": "string",
    "intermediary_bic_swift": "string",
    "branch_code": "string",
    "bsb": "string",
    "currency": "string",
    "description": "string",
    "iban": "string",
    "ifsc": "string",
    "organization_reference_id": "string",
    "pay_id": "string",
    "pay_id_type": "string",
    "sort_code": "string",
    "metadata": {}
}

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/payout-beneficiary/validation-by-body/' \
--header 'X-token;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "company",
    "company": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": 0,
        "company_email": "string",
        "incorporation_country": "string",
        "name": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "registration_number": "string"
    },
    "individual": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "dob": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "identification_custom_type": "string",
        "identification_type": "string",
        "identification_value": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    },
    "aba": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_country": "string",
    "bank_name": "string",
    "beneficiary_name": "string",
    "bic_swift": "string",
    "intermediary_bic_swift": "string",
    "branch_code": "string",
    "bsb": "string",
    "currency": "string",
    "description": "string",
    "iban": "string",
    "ifsc": "string",
    "organization_reference_id": "string",
    "pay_id": "string",
    "pay_id_type": "string",
    "sort_code": "string",
    "metadata": {}
}'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
aba
string 
required
account_number
string 
required
bank_code
string 
required
bank_country
string 
required
bank_name
string 
required
beneficiary_name
string 
required
bic_swift
string 
required
intermediary_bic_swift
string 
required
branch_code
string 
required
bsb
string 
required
company
object 
required
created_at
string 
required
created_by
string 
required
currency
string 
required
description
string 
required
iban
string 
required
ifsc
string 
required
is_active
boolean 
required
metadata
object 
required
org_id
string 
required
organization_reference_id
string 
required
pay_id
string 
required
pay_id_type
string 
required
payout_beneficiary_id
string 
required
proxy_type
string 
required
proxy_value
string 
required
sort_code
string 
required
type
string 
required
updated_at
string 
required
Example
{
    "status": true,
    "message": "string",
    "data": {
        "aba": "string",
        "account_number": "string",
        "bank_code": "string",
        "bank_country": "string",
        "bank_name": "string",
        "beneficiary_name": "string",
        "bic_swift": "string",
        "intermediary_bic_swift": "string",
        "branch_code": "string",
        "bsb": "string",
        "company": {
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zip_code": 0,
            "company_email": "string",
            "company_incorporation_country": "string",
            "name": "string",
            "phone_country_code": "string",
            "phone_number": "string",
            "phone_number_e164": "string",
            "registration_number": "string",
            "identification_type": "string",
            "identification_value": "string"
        },
        "created_at": "2024-12-26T10:53:02.015Z",
        "created_by": "string",
        "currency": "string",
        "description": "string",
        "iban": "string",
        "ifsc": "string",
        "is_active": true,
        "metadata": {},
        "org_id": "string",
        "organization_reference_id": "string",
        "pay_id": "string",
        "pay_id_type": "string",
        "payout_beneficiary_id": "string",
        "proxy_type": "string",
        "proxy_value": "string",
        "sort_code": "string",
        "type": "string",
        "updated_at": "2024-12-26T10:53:02.015Z"
    }
}
🟠400Bad Request
Modified at 2025-05-08 08:11:09
Previous
Validation by Id
Next
Create Payin