GET
/
v1
/
paykeys

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

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
default:
1

Page number for paginated results. Starts at 1.

​
page_size
integer
default:
100

Number of results per page. 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>
default:
asc
Available options:
asc,
desc

Response

200 - text/plain
​
data
object[]
required
​
meta
object
required
​
response_type
enum<string>
required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Available options:
object,
array,
error,
none
Unmask paykey dataCreate a charge