Sign in

v33

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

Search payments

Search for payments, including charges and payouts, using a variety of criteria. This endpoint supports advanced sorting and filtering options.

get/v1/payments

Query parameters

page_numberinteger

Results page number. Starts at page 1.

Results page number. Starts at page 1.

page_sizeinteger

Results page size. Max value: 1000

Results page size. Max value: 1000

sort_by'created_at' | 'payment_date' | 'effective_at' | 'id' | 'amount'

The field to sort the results by.

sort_order'asc' | 'desc'
payment_typePaymentTypeV1[]

Payment type.

Search by the type of a charge or payout.

payment_statusPaymentStatusV1[]

Payment status.

Search by the status of a charge or payout.

payment_idstring uuid

Payment id.

Search using the id of a charge or payout.

external_idstring

External id.

Search using the external_id of a charge or payout.

customer_idstring uuid

Customer id.

Search using the customer_id of a charge or payout.

paykey_idstring uuid

Paykey id.

Search using the paykey_id of a charge or payout.

paykeystring

Paykey.

Search using the paykey of a charge or payout.

min_amountinteger

Minimum amount.

Search using the minimum amount of a chargeorpayout`.

max_amountinteger

Maximum amount.

Search using a maximum amount of a charge or payout.

min_payment_datestring date

Minimum payment date.

Search using the earliest of a charge or payout.

max_payment_datestring date

Maximum payment date.

Search using the latest payment_date of a charge or payout.

min_created_atstring date-time

Minimum created at.

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

max_created_atstring date-time

Maximum created at.

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

min_effective_atstring date-time

Minimum effective at.

Search using the earliest effective_date of a charge or payout.

max_effective_atstring date-time

Maximum effective at.

Search using the latest effective_date of a charge or payout.

funding_idstring uuid

Funding id.

Search using the funding_id of a charge or payout.

search_textstring

Search text.

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

default_page_sizeinteger
default_sort'created_at' | 'payment_date' | 'effective_at' | 'id' | 'amount'

The field to sort the results by.

default_sort_order'asc' | 'desc'
status_reasonStatusReasonV1[]

Reason for latest payment status change.

Reason for latest payment status change.

status_sourceStatusSourceV1[]

Source of latest payment status change.

Source of latest payment status change.

include_metadataboolean

Include the metadata for payments in the returned data.

Include the metadata for payments in the returned data.

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": [
    {
      "description": "Invoice payment for 100 widgets",
      "amount": 10000,
      "customer_details": {
        "name": "Ron Swanson",
        "email": "ron@swanson.com",
        "phone": "+1234567890"
      },
      "paykey_details": {
        "label": "Bank of America ****1234"
      },
      "status_details": {
        "message": "Payment successfully created and awaiting validation."
      }
    }
  ]
}