Payments

Search payments

client.payments.list(?, ?): PageNumberSchema<Data { id, amount, created_at, 15 more } >

get/v1/payments

ModelsExpand Collapse

PaymentSummaryPagedV1 { data, meta, response_type }

data: Array<Data { id, amount, created_at, 15 more } >

id: string

Unique identifier for the charge or payout.

formatuuid

amount: number

The amount of the charge or payout in cents.

formatint32

created_at: string

The time the charge or payout was created.

formatdate-time

currency: string

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

description: string

An arbitrary description for the charge or payout.

external_id: string

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

funding_ids: Array<string>

Funding ids.

paykey: string

Value of the paykey used for the charge or payout.

payment_date: string

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.

formatdate

payment_type: "charge" | "payout"

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

Accepts one of the following:

"charge"

"payout"

status: "created" | "scheduled" | "failed" | 5 more

The current status of the charge or payout.

Accepts one of the following:

"created"

"scheduled"

"failed"

"cancelled"

"on_hold"

"pending"

"paid"

"reversed"

status_details: StatusDetailsV1 { changed_at, message, reason, 2 more }

Details about the current status of the charge or payout.

changed_at: string

The time the status change occurred.

formatdate-time

message: string

A human-readable description of the current status.

reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 17 more

A machine-readable identifier for the specific status, useful for programmatic handling.

Accepts one of the following:

"insufficient_funds"

"closed_bank_account"

"invalid_bank_account"

"invalid_routing"

"disputed"

"payment_stopped"

"owner_deceased"

"frozen_bank_account"

"risk_review"

"fraudulent"

"duplicate_entry"

"invalid_paykey"

"payment_blocked"

"amount_too_large"

"too_many_attempts"

"internal_system_error"

"user_request"

"ok"

"other_network_return"

"payout_refused"

source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more

Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.

Accepts one of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code?: string | null

The status code if applicable.

trace_ids: Record<string, string>

Trace ids.

updated_at: string

The time the charge or payout was last updated.

formatdate-time

customer_details?: CustomerDetailsV1 { id, customer_type, email, 2 more }

Information about the customer associated with the charge or payout.

id: string

Unique identifier for the customer

formatuuid

customer_type: "individual" | "business"

The type of customer

Accepts one of the following:

"individual"

"business"

email: string

The customer's email address

name: string

The name of the customer

phone: string

The customer's phone number in E.164 format

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.

formatdate-time

funding_id?: string | null

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

formatuuid

paykey_details?: PaykeyDetailsV1 { id, customer_id, label, balance }

Information about the paykey used for the charge or payout.

id: string

Unique identifier for the paykey.

formatuuid

customer_id: string

Unique identifier for the customer associated with the paykey.

formatuuid

label: string

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

balance?: number | null

The most recent balance of the bank account associated with the paykey in dollars.

formatint32

meta: Meta { api_request_id, api_request_timestamp, max_page_size, 6 more }

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

max_page_size: number

Maximum allowed page size for this endpoint.

formatint32

page_number: number

Page number for paginated results.

formatint32

page_size: number

Number of items per page in this response.

formatint32

sort_by: string

The field that the results were sorted by.

sort_order: "asc" | "desc"

Accepts one of the following:

"asc"

"desc"

total_items: number

total_pages: number

The number of pages available.

formatint32

response_type: "object" | "array" | "error" | "none"

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.

Accepts one of the following:

"object"

"array"

"error"

"none"