Lookup a paykey

GET

paykeys

{id}

import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const paykeyV1 = await client.paykeys.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

  console.log(paykeyV1.data);
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "source": "bank_account",
    "institution_name": "Bank of America",
    "status": "active",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "reason": "OK",
      "source": "straddle"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234",
      "account_type": "checking"
    },
    "metadata": {}
  }
}

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.

Path Parameters

string

required

Response

200

text/plain

meta

object

required

Metadata about the API request, including an identifier and timestamp.

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

data.id

string

required

Unique identifier for the paykey.

data.label

string

required

Human-readable label used to represent this paykey in a UI.

data.source

enum<string>

required

Available options:

bank_account,

straddle,

mx,

plaid

data.status

enum<string>

default:active

required

Available options:

pending,

active,

inactive,

rejected

data.created_at

string

required

Timestamp of when the paykey was created.

data.updated_at

string

required

Timestamp of the most recent update to the paykey.

data.paykey

string

required

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

data.customer_id

string | null

Unique identifier of the related customer object.

data.institution_name

string | null

Name of the financial institution.

Example:

"Bank of America"

data.status_details

object

data.expires_at

string | null

Expiration date and time of the paykey, if applicable.

data.bank_data

object

data.metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

Suggest edits Raise issue

Bridge a bank account

Unmask paykey data

import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const paykeyV1 = await client.paykeys.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

  console.log(paykeyV1.data);
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "source": "bank_account",
    "institution_name": "Bank of America",
    "status": "active",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "reason": "OK",
      "source": "straddle"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234",
      "account_type": "checking"
    },
    "metadata": {}
  }
}

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Path Parameters

Response