Sign in

v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB
Paykeys

List paykeys

Returns a list of paykeys associated with a Straddle account. This endpoint supports advanced sorting and filtering options.

get/v1/paykeys

Query parameters

customer_idstring uuid

Filter paykeys by related customer ID.

Filter paykeys by related customer ID.

page_numberinteger

Page number for paginated results. Starts at 1.

Page number for paginated results. Starts at 1.

page_sizeinteger

Number of results per page. Maximum: 1000.

Number of results per page. Maximum: 1000.

statusPaykeyStatusV1[]

Filter paykeys by their current status.

Filter paykeys by their current status.

sort_by'institution_name' | 'expires_at' | 'created_at'
sort_order'asc' | 'desc'
sourcePaykeySourceV1[]

Filter paykeys by their source.

Filter paykeys by their source.

unblock_eligibleboolean

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.

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_textstring

General search term to filter paykeys.

General search term to filter paykeys.

created_fromstring date-time

Start date for filtering by creation date.

Start date for filtering by creation date.

created_tostring date-time

End date for filtering by creation date.

End date for filtering by creation date.

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' 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.

Example response

{
  "data": [
    {
      "label": "Bank of America ****1234",
      "institution_name": "Bank of America",
      "status_details": {
        "message": "Bank account sucesfully validated"
      },
      "bank_data": {
        "routing_number": "021000021",
        "account_number": "****1234"
      }
    }
  ]
}