Payments
Search payments
ModelsExpand Collapse
class PaymentSummaryPagedV1: …
data: List[Data]
id: str
Unique identifier for the charge or payout.
amount: int
The amount of the charge or payout in cents.
created_at: datetime
The time the charge or payout was created.
currency: str
The currency of the charge or payout. Only USD is supported.
description: str
An arbitrary description for the charge or payout.
external_id: str
Unique identifier for the charge or payout in your database. This value must be unique across all charges or payouts.
funding_ids: List[str]
Funding ids.
paykey: str
Value of the paykey used for the charge or payout.
payment_date: date
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.
payment_type: Literal["charge", "payout"]
The type of payment. Valid values are charge or payout.
status: Literal["created", "scheduled", "failed", 5 more]
The current status of the charge or payout.
Details about the current status of the charge or payout.
changed_at: datetime
The time the status change occurred.
message: str
A human-readable description of the current status.
reason: Literal["insufficient_funds", "closed_bank_account", "invalid_bank_account", 17 more]
A machine-readable identifier for the specific status, useful for programmatic handling.
source: Literal["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.
code: Optional[str]
The status code if applicable.
trace_ids: Dict[str, str]
Trace ids.
updated_at: datetime
The time the charge or payout was last updated.
customer_details: Optional[CustomerDetailsV1]
Information about the customer associated with the charge or payout.
id: str
Unique identifier for the customer
customer_type: Literal["individual", "business"]
The type of customer
email: str
The customer's email address
name: str
The name of the customer
phone: str
The customer's phone number in E.164 format
effective_at: Optional[datetime]
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.
funding_id: Optional[str]
Unique identifier for the funding event associated with the charge or payout.
paykey_details: Optional[PaykeyDetailsV1]
Information about the paykey used for the charge or payout.
id: str
Unique identifier for the paykey.
customer_id: str
Unique identifier for the customer associated with the paykey.
label: str
Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI
balance: Optional[int]
The most recent balance of the bank account associated with the paykey in dollars.
meta: Meta
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
max_page_size: int
Maximum allowed page size for this endpoint.
page_number: int
Page number for paginated results.
page_size: int
Number of items per page in this response.
sort_by: str
The field that the results were sorted by.
sort_order: Literal["asc", "desc"]
total_pages: int
The number of pages available.
response_type: Literal["object", "array", "error", "none"]
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.