API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Funding Events

List funding events

client.fundingEvents.list(FundingEventListParams { created_from, created_to, direction, 10 more } params?, RequestOptionsoptions?): PageNumberSchema<Data { id, amount, created_at, 8 more } >

get/v1/funding_events

Lookup a funding event

client.fundingEvents.get(stringid, FundingEventGetParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): FundingEventSummaryItemV1 { data, meta, response_type }

get/v1/funding_events/{id}

ModelsExpand Collapse

FundingEventSummaryItemV1 { data, meta, response_type }

data: Data { id, amount, created_at, 8 more }

id: string

Unique identifier for the funding event.

formatuuid

amount: number

The amount of the funding event in cents.

formatint32

created_at: string

Created at.

formatdate-time

direction: "deposit" | "withdrawal"

Describes the direction of the funding event from the perspective of the linked_bank_account.

Accepts one of the following:

"deposit"

"withdrawal"

event_type: "charge_deposit" | "charge_reversal" | "payout_return" | "payout_withdrawal"

The funding event types describes the direction and reason for the funding event.

Accepts one of the following:

"charge_deposit"

"charge_reversal"

"payout_return"

"payout_withdrawal"

payment_count: number

The number of payments associated with the funding event.

formatint32

trace_ids: Record<string, string>

Trace Ids.

trace_numbers: Array<string>

Trace number.

transfer_date: string

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.

formatdate

updated_at: string

Updated at.

formatdate-time

trace_number?: string | null

The trace number of the funding event.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

Metadata about the API request, including an identifier and timestamp.

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

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"

FundingEventSummaryPagedV1 { data, meta, response_type }

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

id: string

Unique identifier for the funding event.

formatuuid

amount: number

The amount of the funding event in cents.

formatint32

created_at: string

Created at.

formatdate-time

direction: "deposit" | "withdrawal"

Describes the direction of the funding event from the perspective of the linked_bank_account.

Accepts one of the following:

"deposit"

"withdrawal"

event_type: "charge_deposit" | "charge_reversal" | "payout_return" | "payout_withdrawal"

The funding event types describes the direction and reason for the funding event.

Accepts one of the following:

"charge_deposit"

"charge_reversal"

"payout_return"

"payout_withdrawal"

payment_count: number

The number of payments associated with the funding event.

formatint32

trace_ids: Record<string, string>

Trace Ids.

trace_numbers: Array<string>

Trace number.

transfer_date: string

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.

formatdate

updated_at: string

Updated at.

formatdate-time

trace_number?: string | null

The trace number of the funding event.

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"