Funding Events
List funding events
Lookup a funding event
ModelsExpand Collapse
class FundingEventSummaryItemV1 { data, meta, response_type }
data: { id, amount, created_at, 8 more}
id: String
Unique identifier for the funding event.
amount: Integer
The amount of the funding event in cents.
created_at: Time
Created at.
direction: :deposit | :withdrawal
Describes the direction of the funding event from the perspective of the linked_bank_account.
event_type: :charge_deposit | :charge_reversal | :payout_return | :payout_withdrawal
The funding event types describes the direction and reason for the funding event.
payment_count: Integer
The number of payments associated with the funding event.
trace_ids: Hash[Symbol, String]
Trace Ids.
trace_numbers: Array[String]
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: Time
Updated at.
trace_number: String
The trace number of the funding event.
Metadata about the API request, including an identifier and timestamp.
api_request_id: String
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: Time
Timestamp for this API request, useful for troubleshooting.
response_type: :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, meta, response_type }
data: Array[{ id, amount, created_at, 8 more}]
id: String
Unique identifier for the funding event.
amount: Integer
The amount of the funding event in cents.
created_at: Time
Created at.
direction: :deposit | :withdrawal
Describes the direction of the funding event from the perspective of the linked_bank_account.
event_type: :charge_deposit | :charge_reversal | :payout_return | :payout_withdrawal
The funding event types describes the direction and reason for the funding event.
payment_count: Integer
The number of payments associated with the funding event.
trace_ids: Hash[Symbol, String]
Trace Ids.
trace_numbers: Array[String]
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: Time
Updated at.
trace_number: String
The trace number of the funding event.
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.
api_request_timestamp: Time
Timestamp for this API request, useful for troubleshooting.
max_page_size: Integer
Maximum allowed page size for this endpoint.
page_number: Integer
Page number for paginated results.
page_size: Integer
Number of items per page in this response.
sort_by: String
The field that the results were sorted by.
sort_order: :asc | :desc
total_pages: Integer
The number of pages available.
response_type: :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.