GET
/
v1
/
funding_events

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

​
Straddle-Account-Id
string

For use by platforms to specify an account id and set scope of a request.

​
Request-Id
string

Optional client generated identifier to trace and debug a request.

​
Correlation-Id
string

Optional client generated identifier to trace and debug a series of requests.

Query Parameters

​
page_number
integer
default:
1

Results page number. Starts at page 1.

​
page_size
integer
default:
100

Results page size. Max value: 1000

​
sort_by
enum<string>
Available options:
transfer_date,
id,
amount
​
sort_order
enum<string>
default:
asc
Available options:
asc,
desc
​
created_from
string | null

The start date of the range to filter by using the YYYY-MM-DD format.

​
created_to
string | null

The end date of the range to filter by using the YYYY-MM-DD format.

​
direction
enum<string>

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

Available options:
deposit,
withdrawal
​
event_type
enum<string>

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

Available options:
charge_deposit,
charge_reversal,
payout_return,
payout_withdrawal
​
trace_number
string | null

Trace number.

Response

200 - text/plain
​
data
object[]
required
​
meta
object
required
​
response_type
enum<string>
required

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.
Available options:
object,
array,
error,
none
Cancel a payoutLookup funding details