API Documentation
  1. Payout Beneficiary
API Documentation
  • Checkout Page
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payout Method
      • Get All Payout Method
      • Get Required Fields by Payout method
    • Payin
      • Create Payin
      • Simulate Payin
      • Retrieve Payin
      • Retrieve Payin Memo (PDF)
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout
      • Get All Payout
      • Retrieve Payout Memo (PDF)
    • 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
    • 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
    • Checkout
      • Create Payment Request
      • Create New Checkout
      • Get List Checkout Payment Method by Currency
      • Get All Checkout
      • Get Detail Checkout
      • Cancel Checkout
      • Get VA Bank Information [KRW]
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
  • 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

Get All Payout Beneficiary

GET
/api/v1/payout-beneficiary/all-beneficiary
This API is used to retrieve a list of all the Payout beneficiaries.
You can use query parameters to filter the list with customize limit and page parameters as per the requirements.

Request

Query Params
type
enum<string> 
optional
Allowed values:
individualcompany
Example:
individual
created_at
string <date>
optional
start_time
number 
optional
end_time
number 
optional
limit
number 
optional
page
number 
optional
Header Params
X-token
string 
optional

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-beneficiary/all-beneficiary?type=individual&created_at&start_time&end_time&limit&page' \
--header 'X-token;'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
array [object {29}] 
required
aba
string 
optional
account_number
string 
optional
bank_code
string 
optional
bank_country
string 
optional
bank_name
string 
optional
beneficiary_name
string 
optional
bic_swift
string 
optional
intermediary_bic_swift
string 
optional
branch_code
string 
optional
bsb
string 
optional
company
object 
optional
created_at
string 
optional
created_by
string 
optional
currency
string 
optional
description
string 
optional
iban
string 
optional
ifsc
string 
optional
is_active
boolean 
optional
metadata
object 
optional
org_id
string 
optional
organization_reference_id
string 
optional
pay_id
string 
optional
pay_id_type
string 
optional
payout_beneficiary_id
string 
optional
proxy_type
string 
optional
proxy_value
string 
optional
sort_code
string 
optional
type
string 
optional
updated_at
string 
optional
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:41:41.996Z",
      "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:41:41.996Z"
    }
  ]
}
🟠400Bad Request
Modified at 2025-03-12 01:18:04
Previous
Update Payout Beneficiary
Next
Get Payout Beneficiary by Id