Search for all Payments

GET

payments

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() {
  // Automatically fetches more pages as needed.
  for await (const payment of client.payments.list()) {
    console.log(payment.id);
  }
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_type": "charge",
      "payment_date": "2023-12-25",
      "effective_at": "2023-11-07T05:31:56Z",
      "description": "Invoice payment for 100 widgets",
      "external_id": "<string>",
      "amount": "10000",
      "currency": "USD",
      "customer_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Ron Swanson",
        "customer_type": "individual",
        "email": "ron@swanson.com",
        "phone": "+1234567890"
      },
      "paykey": "<string>",
      "paykey_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Bank of America ****1234",
        "balance": "100.00"
      },
      "status": "created",
      "status_details": {
        "message": "Payment successfully created and awaiting validation.",
        "reason": "OK",
        "source": "system",
        "changed_at": "2023-11-07T05:31:56Z",
        "code": null
      },
      "funding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "funding_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

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

page_number

integer

default:1

Results page number. Starts at page 1.

page_size

integer

default:100

Results page size. Max value: 1000

sort_by

enum<string>

default:id

The field to sort the results by.

Available options:

created_at,

payment_date,

effective_at,

id,

amount

sort_order

enum<string>

default:asc

Available options:

asc,

desc

payment_type

enum<string>[]

Search by the type of a charge or payout.

The type of payment.

Available options:

charge,

payout

payment_status

enum<string>[]

Search by the status of a charge or payout.

The current status of the charge or payout.

Available options:

created,

scheduled,

failed,

cancelled,

on_hold,

pending,

paid,

reversed

payment_id

string

Search using the id of a charge or payout.

external_id

string

Search using the external_id of a charge or payout.

customer_id

string

Search using the customer_id of a charge or payout.

paykey_id

string

Search using the paykey_id of a charge or payout.

paykey

string

Search using the paykey of a charge or payout.

min_amount

integer

Search using the minimum amount of a chargeorpayout`.

max_amount

integer

Search using a maximum amount of a charge or payout.

min_payment_date

string

Search using the earliest of a charge or payout.

max_payment_date

string

Search using the latest payment_date of a charge or payout.

min_created_at

string

Search using the earliest created_at date of a charge or payout.

max_created_at

string

Search using the latest created_at date of a charge or payout.

min_effective_at

string

Search using the earliest effective_date of a charge or payout.

max_effective_at

string

Search using the latest effective_date of a charge or payout.

funding_id

string

Search using the funding_id of a charge or payout.

search_text

string

Search using a text string associated with a charge or payout.

default_page_size

integer

default_sort

enum<string>

default:id

The field to sort the results by.

Available options:

created_at,

payment_date,

effective_at,

id,

amount

default_sort_order

enum<string>

default:asc

Available options:

asc,

desc

Response

200

text/plain

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

data.id

string

required

Unique identifier for the charge or payout.

data.payment_type

enum<string>

required

The type of payment. Valid values are charge or payout.

Available options:

charge,

payout

data.payment_date

string

required

The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on. For payouts, this means the date you want the funds to be sent from your bank account.

data.description

string

required

An arbitrary description for the charge or payout.

Example:

"Invoice payment for 100 widgets"

data.external_id

string

required

Unique identifier for the charge or payout in your database. This value must be unique across all charges or payouts.

data.amount

integer

required

The amount of the charge or payout in cents.

Example:

"10000"

data.currency

string

default:USD

required

The currency of the charge or payout. Only USD is supported.

data.paykey

string

required

Value of the paykey used for the charge or payout.

data.status

enum<string>

default:created

required

The current status of the charge or payout.

Available options:

created,

scheduled,

failed,

cancelled,

on_hold,

pending,

paid,

reversed

data.status_details

object

required

Details about the current status of the charge or payout.

data.created_at

string

required

The time the charge or payout was created.

data.updated_at

string

required

The time the charge or payout was last updated.

data.funding_ids

string[]

required

Funding ids.

data.effective_at

string | null

The actual date on which the payment occurred. For charges, this is the date the customer was debited. For payouts, this is the date the funds were sent from your bank account.

data.customer_details

object

Information about the customer associated with the charge or payout.

data.paykey_details

object

Information about the paykey used for the charge or payout.

data.funding_id

string | null

Unique identifier for the funding event associated with the charge or payout.

Suggest edits Raise issue

Lookup funding details

Create an organization

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() {
  // Automatically fetches more pages as needed.
  for await (const payment of client.payments.list()) {
    console.log(payment.id);
  }
}

main();

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_type": "charge",
      "payment_date": "2023-12-25",
      "effective_at": "2023-11-07T05:31:56Z",
      "description": "Invoice payment for 100 widgets",
      "external_id": "<string>",
      "amount": "10000",
      "currency": "USD",
      "customer_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Ron Swanson",
        "customer_type": "individual",
        "email": "ron@swanson.com",
        "phone": "+1234567890"
      },
      "paykey": "<string>",
      "paykey_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Bank of America ****1234",
        "balance": "100.00"
      },
      "status": "created",
      "status_details": {
        "message": "Payment successfully created and awaiting validation.",
        "reason": "OK",
        "source": "system",
        "changed_at": "2023-11-07T05:31:56Z",
        "code": null
      },
      "funding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "funding_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Query Parameters

Response