Funding Events

List funding events

Changed on

Retrieves a list of funding events for your account. This endpoint supports advanced sorting and filtering options.

get/v1/funding_events

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/funding_events
  • Auth
    HTTP bearer

Query parameters

page_numberinteger

Results page number. Starts at page 1.

page_sizeinteger

Results page size. Max value: 1000

sort_by'transfer_date' | 'id' | 'amount'
sort_order'asc' | 'desc'
created_fromstring date nullable

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

created_tostring date nullable

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

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.

trace_numberstring nullable

Trace number.

search_textstring nullable

Search text.

statusPaymentStatusV1[] nullable

Payment status.

Funding Event status.

trace_idstring nullable

Trace Id.

status_reasonStatusReasonV1[] nullable

Reason for latest payment status change.

status_sourceStatusSourceV1[] nullable

Source of latest payment status change.

Headers

Straddle-Account-Idstring uuid

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

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

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

Response

OK

response_type'object' | 'array' | 'error' | 'none' 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.

Example response

{
  "data": [
    {
      "status_details": {
        "message": "Bank account sucesfully validated"
      }
    }
  ]
}

Changes

  • 456c9ef0c3a6Revision changes
    • warning

      added the new auto_hold enum value to the /// response property for the response status (media type: text/plain)

    • warning

      added the new auto_hold enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new auto_hold enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new validating enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new validating enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new validating enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new validating enum value to the /// response property for the response status (media type: text/plain)

    • warning

      added the new validating enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new validating enum value to the /// response property for the response status (media type: text/json)

    • info

      added the enum value auto_hold to the property items/ of the query request parameter status_reason

    • info

      added the enum value validating to the property items/ of the query request parameter status

    • info

      added the enum value validating to the property items/ of the query request parameter status_reason

  • 197302a1e983Revision changes
    • breaking

      removed the enum value auto_hold from the property items/ of the query request parameter status_reason

    • breaking

      removed the enum value validating from the property items/ of the query request parameter status

    • breaking

      removed the enum value validating from the property items/ of the query request parameter status_reason

    • info

      removed the auto_hold enum value from the /// response property for the response status (media type: text/plain)

    • info

      removed the auto_hold enum value from the /// response property for the response status (media type: application/json)

    • info

      removed the auto_hold enum value from the /// response property for the response status (media type: text/json)

    • info

      removed the validating enum value from the // response property for the response status (media type: text/plain)

    • info

      removed the validating enum value from the // response property for the response status (media type: application/json)

    • info

      removed the validating enum value from the // response property for the response status (media type: text/json)

    • info

      removed the validating enum value from the /// response property for the response status (media type: text/plain)

    • info

      removed the validating enum value from the /// response property for the response status (media type: application/json)

    • info

      removed the validating enum value from the /// response property for the response status (media type: text/json)