List paykeys

GET/v1/paykeys

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

ParametersExpand Collapse

PaykeyListParams parameters

string customerID

Query param: Filter paykeys by related customer ID.

formatuuid

Int pageNumber

Query param: Page number for paginated results. Starts at 1.

formatint32

Int pageSize

Query param: Number of results per page. Maximum: 1000.

formatint32

string searchText

Query param: General search term to filter paykeys.

SortBy sortBy

Query param

SortOrder sortOrder

Query param

IReadOnlyList<Source> source

Query param: Filter paykeys by their source.

IReadOnlyList<Status> status

Query param: Filter paykeys by their current status.

Boolean unblockEligible

Query param: 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.

string correlationID

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

string requestID

Header param: Optional client generated identifier to trace and debug a request.

string straddleAccountID

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

formatuuid

ReturnsExpand Collapse

class PaykeySummaryPagedV1:

required IReadOnlyList<Data> Data

required string ID

Unique identifier for the paykey.

formatuuid

required Config Config

ProcessingMethod ProcessingMethod

One of the following:

SandboxOutcome SandboxOutcome

One of the following:

required DateTimeOffset CreatedAt

Timestamp of when the paykey was created.

formatdate-time

required string Label

Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

required string Paykey

The tokenized paykey value. This value is used to create payments and should be stored securely.

required Source Source

One of the following:

required Status Status

One of the following:

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the paykey.

formatdate-time

BankData BankData

required string AccountNumber

Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value.

required AccountType AccountType

One of the following:

required string RoutingNumber

The routing number of the bank account.

minLength9

maxLength9

string? CustomerID

Unique identifier of the related customer object.

formatuuid

DateTimeOffset? ExpiresAt

Expiration date and time of the paykey, if applicable.

formatdate-time

string? ExternalID

Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

string? InstitutionName

Name of the financial institution.

StatusDetails StatusDetails

required DateTimeOffset ChangedAt

The time the status change occurred.

formatdate-time

required string Message

A human-readable description of the current status.

required Reason Reason

One of the following:

required Source Source

One of the following:

string? Code

The status code if applicable.

Boolean? UnblockEligible

Indicates whether this paykey is eligible for client-initiated unblocking. Only present for blocked paykeys. True when blocked due to R29 returns and not previously unblocked, false otherwise. Null when paykey is not blocked.

required Meta Meta

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid

required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time

required Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32

required Int PageNumber

Page number for paginated results.

formatint32

required Int PageSize

Number of items per page in this response.

formatint32

required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder

One of the following:

required Int TotalItems

required Int TotalPages

The number of pages available.

formatint32

required ResponseType ResponseType

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.

One of the following:

List paykeys

PaykeyListParams parameters = new();

var page = await client.Paykeys.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "processing_method": "inline",
        "sandbox_outcome": "standard"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "label": "Bank of America ****1234",
      "paykey": "paykey",
      "source": "bank_account",
      "status": "pending",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "bank_data": {
        "account_number": "****1234",
        "account_type": "checking",
        "routing_number": "021000021"
      },
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "institution_name": "Bank of America",
      "status_details": {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Bank account sucesfully validated",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "code": "code"
      },
      "unblock_eligible": true
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "config": {
        "processing_method": "inline",
        "sandbox_outcome": "standard"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "label": "Bank of America ****1234",
      "paykey": "paykey",
      "source": "bank_account",
      "status": "pending",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "bank_data": {
        "account_number": "****1234",
        "account_type": "checking",
        "routing_number": "021000021"
      },
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "institution_name": "Bank of America",
      "status_details": {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Bank account sucesfully validated",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "code": "code"
      },
      "unblock_eligible": true
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}