GET
/
v1
/
paykeys

Authorizations

​
Authorization
string
header
required

JWT 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

Filter paykeys by related customer ID.

​
page_number
integer

Page number for paginated results. Starts at 1. Default: 1.

​
page_size
integer

Number of results per page. Default: 100. Maximum: 1000.

​
status
enum<string>[]

Filter paykeys by their current 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
OK
​
meta
object
required
​
response_type
enum<string>
required
Available options:
object,
array,
error,
none
​
data
object[]
required

Was this page helpful?

Suggest editsRaise issue
Unmask paykey dataCreate a charge