Funding Events
List funding events
Lookup a funding event
ModelsExpand Collapse
class FundingEventSummaryItemV1: …
data: Data
id: str
Unique identifier for the funding event.
amount: int
The amount of the funding event in cents.
created_at: datetime
Created at.
direction: Literal["deposit", "withdrawal"]
Describes the direction of the funding event from the perspective of the linked_bank_account.
event_type: Literal["charge_deposit", "charge_reversal", "payout_return", "payout_withdrawal"]
The funding event types describes the direction and reason for the funding event.
payment_count: int
The number of payments associated with the funding event.
trace_ids: Dict[str, str]
Trace Ids.
trace_numbers: List[str]
Trace number.
transfer_date: date
The date on which the funding event occurred. For deposits and returns, this is the date the funds were credited to your bank account. For withdrawals and reversals, this is the date the funds were debited from your bank account.
updated_at: datetime
Updated at.
trace_number: Optional[str]
The trace number of the funding event.
Metadata about the API request, including an identifier and timestamp.
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.
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.
class FundingEventSummaryPagedV1: …
data: List[Data]
id: str
Unique identifier for the funding event.
amount: int
The amount of the funding event in cents.
created_at: datetime
Created at.
direction: Literal["deposit", "withdrawal"]
Describes the direction of the funding event from the perspective of the linked_bank_account.
event_type: Literal["charge_deposit", "charge_reversal", "payout_return", "payout_withdrawal"]
The funding event types describes the direction and reason for the funding event.
payment_count: int
The number of payments associated with the funding event.
trace_ids: Dict[str, str]
Trace Ids.
trace_numbers: List[str]
Trace number.
transfer_date: date
The date on which the funding event occurred. For deposits and returns, this is the date the funds were credited to your bank account. For withdrawals and reversals, this is the date the funds were debited from your bank account.
updated_at: datetime
Updated at.
trace_number: Optional[str]
The trace number of the funding event.
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.