VAvalorpaytech

Get Customer List

get/api/fl-valor-vault/getcustomerslist

Request

  • Base URL
    https://demo.valorpaytech.com
  • URL
    https://demo.valorpaytech.com/api/fl-valor-vault/getcustomerslist
  • Auth
    none required

Query parameters

limitstring required

Maximum number of records to return. Default: 5. Allowed range: 1–50. Example: 5

offsetstring required

Number of records to skip for pagination. Default: 0. Example: 0

vault_idinteger

Filter results by a specific Vault ID. Example: 1001

customer_namestring

Filter results by customer name. Example: John Doe

emailstring

Filter results by email address. Must be a valid email format. Example: john.doe@example.com

phonestring

Filter results by customer phone number. Example: 9876543210

companystring

Filter results by associated company name. Example: ABC Corporation

total_card_count_mininteger

Filter customers with at least the specified number of cards. Example: 1

total_card_count_maxinteger

Filter customers with at most the specified number of cards. Must be greater than or equal to total_card_count_min. Example: 10

total_recursive_billing_minstring

Filter customers with at least the specified number of recurring billings. Example: 1

total_recursive_billing_maxstring

Filter customers with at most the specified number of recurring billings. Must be greater than or equal to total_recursive_billing_min. Example: 5

transaction_count_mininteger

Filter customers with at least the specified number of transactions. Example: 1

transaction_count_maxinteger

Filter customers with at most the specified number of transactions. Must be greater than or equal to transaction_count_min. Example: 100

last_txn_date_beforestring date

Filter customers whose last transaction occurred before the specified date. Format: YYYY-MM-DD. Example: 2024-06-30

last_txn_date_afterstring date

Filter customers whose last transaction occurred after the specified date. Format: YYYY-MM-DD. Example: 2024-06-01

searchstring

Search by customer name, email address, or phone number. Example: John

Headers

Valor-App-IDstring required

Must be 32 characters and can contain alphabets, numbers, and special characters ($ @ % #). Example: Vw7RdW6IPmRH4Z2feCE8Pp1iqeahSonN

Valor-App-Keystring required

Must be 32 characters and can contain alphabets, numbers, and special characters ($ @ % #). Example: Tv26MihzxwblHyk6gEuVelY2XwQE58jU

Response

200

codeinteger
statusstring
number_of_recordsinteger
page_numberinteger
total_pagesinteger
total_countinteger
page_sizeinteger

Example response

{
  "code": 200,
  "status": "SUCCESS",
  "data": {
    "customers": [
      {
        "vault_id": 125639,
        "customer_name": "Melvin",
        "email": "catherinepelliott@dayrep.com",
        "phone": "6129160161",
        "company": "Home Centers",
        "total_card_count": 2
      }
    ]
  },
  "number_of_records": 1,
  "page_number": 1,
  "total_pages": 21,
  "total_count": 21,
  "page_size": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.