API Documentation
  1. Customer
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
      • 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
        POST
      • Update Customer
        PATCH
      • Get All Customer
        GET
      • Get Detail Customer by Id
        GET
      • Check Is Customer Wallet Ready
        GET
      • Enable Customer
        PATCH
      • Disable Customer
        PATCH
      • Delete Customer
        DELETE
    • 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. Customer

Get All Customer

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

Request

Header Params
X-token
string 
required

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/customer' \
--header 'X-token;'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
array [object {19}] 
required
customer_id
string 
optional
org_id
string 
optional
type
string 
optional
description
object 
optional
webhook_url
object 
optional
metadata
object 
optional
is_active
boolean 
optional
is_wallet_ready
boolean 
optional
organization_reference_id
object 
optional
is_gca_enabled
boolean 
optional
gca_activation_status
string 
optional
gca_activated_at
object 
optional
is_sender_validation_enabled
boolean 
optional
payin_sender_id_list
object 
optional
company_domain
object 
optional
company
object 
optional
created_by
string 
optional
created_at
string 
optional
updated_at
string 
optional
Example
{
    "status": true,
    "message": "string",
    "data": [
        {
            "customer_id": "string",
            "org_id": "string",
            "type": "string",
            "description": {},
            "webhook_url": {},
            "metadata": {},
            "is_active": true,
            "is_wallet_ready": true,
            "organization_reference_id": {},
            "is_gca_enabled": true,
            "gca_activation_status": "string",
            "gca_activated_at": {},
            "is_sender_validation_enabled": true,
            "payin_sender_id_list": {},
            "company_domain": {},
            "company": {
                "company_domain": {},
                "name": "string",
                "registration_number": "string",
                "incorporation_country": "string",
                "address_country": "string",
                "address_state": "string",
                "address_city": "string",
                "address_line1": "string",
                "address_line2": {},
                "address_zip_code": "string",
                "phone_number": "string",
                "phone_country_code": "string",
                "phone_number_e164": "string",
                "email": "string",
                "authorized_user": {
                    "first_name": "string",
                    "last_name": "string",
                    "dob": "string",
                    "email": "string",
                    "nationality": "string",
                    "address_country": "string",
                    "address_state": "string",
                    "address_city": "string",
                    "address_line1": "string",
                    "address_line2": {},
                    "address_zip_code": "string",
                    "country_of_residence": "string",
                    "phone_number": "string",
                    "phone_country_code": "string",
                    "phone_number_e164": "string",
                    "identification_type": "string",
                    "identification_custom_type": {},
                    "identification_value": "string"
                }
            },
            "created_by": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    ]
}
🟠400Bad Request
Modified at 2025-03-12 01:18:39
Previous
Update Customer
Next
Get Detail Customer by Id