Skip to main content
GET
Get or List Customers

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

X-TenantID
string
header
required

live or test

Scopes

Payaza {{Public API Key In Base64}}
ApiKeyAuth
test or live
TenantID

Query Parameters

operation
enum<string>
default:LIST
required

Specifies the operation to perform. Select GET for a single customer or LIST for a paginated list.

Available options:
GET,
LIST
customer_reference
string

Required if operation=GET. The unique customer reference supplied during customer creation.

Example:

"account_001"

page_number
integer
default:1

Required if operation=LIST. The page number to retrieve.

page_size
integer
default:10

Required if operation=LIST. The number of records per page.

Response

Request Successful

message
string

A descriptive message regarding the overall outcome of the operation.

Example:

"Customer retrieved"

status
boolean

This indicates whether the request was successful.

Example:

true

retry_count
integer

The number of retries attempted during processing.

Example:

0

data
object

The payload containing the retrieved customer details.