Query a customer

get

https://api.preproduction.powerboard.commbank.com.au/v1/customers/{id}

Search for all or a specific customer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The customer ID returned at the creation stage. Omitting this will return a list of all customers.

Query Params

limit

string

Pagination parameter to limit output to n , default = 100 , maximum value = 1000

skip

string

Pagination parameter to skip first n customers from list, default = 0

sortkey

string

Sorting key parameter i.e. created_at

sortdirection

string

Sorting order direction parameter ASC or DESC (DESC by default)

gateway_id

string

ID of a gateway with which charges were created

payment_source_id

string

ID of a stored customers payment_source

status

string

archived

boolean

Defaults to false

Set to true to show all the archived charges.

reference

string

The manually defined reference from the creation stage.

company_name

string

The company name defined in the customer creation stage

string

Word or phrase you want to search on your customers.

Headers

x-user-secret-key

string

required

Your API private/secret key. This can be found in the powerboard dashboard.

Responses

200200

400400