Paykeys
Search paykeys
Search paykeys with filters
GET
/
v1
/
paykeys
Authorizations
Authorization
string
headerrequiredJWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
Headers
Straddle-Account-Id
string
For use by platforms to specify an account id and set scope of a request.
Request-Id
string
Optional client generated identifier to trace and debug a request.
Correlation-Id
string
Optional client generated identifier to trace and debug a series of requests.
Query Parameters
customer_id
string
Customer whose paykeys you wish to list.
check_for_unmask
boolean
Optional customer type filter.
page_number
integer
Results page number. Starts at page 1. Default value: 1
page_size
integer
Page size. Default value: 100. Max value: 1000
status
enum<string>[]
Pay key status
Available options:
pending
, active
, inactive
, rejected
sort_by
enum<string>
Available options:
institution_name
, expires_at
, created_at
sort_order
enum<string>
Available options:
asc
, desc
Response
200 - text/plain
meta
object
response_type
string | null
The type of the response
data
object[] | null
The data of the response