Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Headers

Straddle-Account-Id
string<uuid>

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<uuid>

Filter paykeys by related customer ID.

page_number
integer<int32>
default:1

Page number for paginated results. Starts at 1.

page_size
integer<int32>
default:100

Number of results per page. Maximum: 1000.

status
enum<string>[]

Filter paykeys by their current status.

Available options:
pending,
active,
inactive,
rejected,
review,
blocked
sort_by
enum<string>
Available options:
institution_name,
expires_at,
created_at
sort_order
enum<string>
default:asc
Available options:
asc,
desc
source
enum<string>[]

Filter paykeys by their source.

Available options:
bank_account,
straddle,
mx,
plaid,
tan,
quiltt
unblock_eligible
boolean

Filter paykeys by unblock eligibility. When true, returns only blocked paykeys eligible for client-initiated unblocking (blocked due to R29 returns and not previously unblocked). When false, returns only blocked paykeys that are not eligible for unblocking.

search_text
string

General search term to filter paykeys.

created_from
string<date-time>

Start date for filtering by creation date.

created_to
string<date-time>

End date for filtering by creation date.

Response

OK

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
data
object[]
required