v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Get Customer List

get/api/valor-vault/getcustomerslist

Query parameters

limitinteger required

Limit for pagnation. Max 50 and default as 0

offsetstring required

Offset for pagination. Default as 0

vault_idinteger

Filter by a specific vault ID

customer_namestring

Filter results by customer name

emailstring

Filter by email address. Must be a valid email format

phonestring

Filter by customer phone number

companystring

Filter by associated company name

total_card_count_mininteger

Minimum number of cards associated with the customer

total_card_count_maxinteger

Maximum number of cards. Must be greater than or equal to total_card_count_min.

total_recursive_billing_mininteger

Minimum number of recurring billing

total_recursive_billing_maxinteger

Maximum number of recurring billing

transaction_count_mininteger

Minimum number of transactions for the customer

transaction_count_maxinteger

Maximum number of transactions

last_txn_date_beforestring date

Filter customers whose last transaction occurred before this date

last_txn_date_afterstring date

Filter customers whose last transaction occurred after this date

searchstring

A general search term. Matches against customer name, email, or phone.

Headers

Valor-App-IDstring required

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

Valor-App-Keystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

Response

200

object required