## List funding events `client.FundingEvents.List(ctx, params) (*PageNumberSchema[FundingEventSummaryPagedV1Data], error)` **get** `/v1/funding_events` Retrieves a list of funding events for your account. This endpoint supports advanced sorting and filtering options. ### Parameters - `params FundingEventListParams` - `CreatedFrom param.Field[Time]` Query param: The start date of the range to filter by using the `YYYY-MM-DD` format. - `CreatedTo param.Field[Time]` Query param: The end date of the range to filter by using the `YYYY-MM-DD` format. - `Direction param.Field[FundingEventListParamsDirection]` Query param: Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `const FundingEventListParamsDirectionDeposit FundingEventListParamsDirection = "deposit"` - `const FundingEventListParamsDirectionWithdrawal FundingEventListParamsDirection = "withdrawal"` - `EventType param.Field[FundingEventListParamsEventType]` Query param: The funding event types describes the direction and reason for the funding event. - `const FundingEventListParamsEventTypeChargeDeposit FundingEventListParamsEventType = "charge_deposit"` - `const FundingEventListParamsEventTypeChargeReversal FundingEventListParamsEventType = "charge_reversal"` - `const FundingEventListParamsEventTypePayoutReturn FundingEventListParamsEventType = "payout_return"` - `const FundingEventListParamsEventTypePayoutWithdrawal FundingEventListParamsEventType = "payout_withdrawal"` - `PageNumber param.Field[int64]` Query param: Results page number. Starts at page 1. - `PageSize param.Field[int64]` Query param: Results page size. Max value: 1000 - `SearchText param.Field[string]` Query param: Search text. - `SortBy param.Field[FundingEventListParamsSortBy]` Query param: The field to sort the results by. - `const FundingEventListParamsSortByTransferDate FundingEventListParamsSortBy = "transfer_date"` - `const FundingEventListParamsSortByID FundingEventListParamsSortBy = "id"` - `const FundingEventListParamsSortByAmount FundingEventListParamsSortBy = "amount"` - `SortOrder param.Field[FundingEventListParamsSortOrder]` Query param: The order in which to sort the results. - `const FundingEventListParamsSortOrderAsc FundingEventListParamsSortOrder = "asc"` - `const FundingEventListParamsSortOrderDesc FundingEventListParamsSortOrder = "desc"` - `Status param.Field[[]string]` Query param: Funding Event status. - `const FundingEventListParamsStatusCreated FundingEventListParamsStatus = "created"` - `const FundingEventListParamsStatusScheduled FundingEventListParamsStatus = "scheduled"` - `const FundingEventListParamsStatusFailed FundingEventListParamsStatus = "failed"` - `const FundingEventListParamsStatusCancelled FundingEventListParamsStatus = "cancelled"` - `const FundingEventListParamsStatusOnHold FundingEventListParamsStatus = "on_hold"` - `const FundingEventListParamsStatusPending FundingEventListParamsStatus = "pending"` - `const FundingEventListParamsStatusPaid FundingEventListParamsStatus = "paid"` - `const FundingEventListParamsStatusReversed FundingEventListParamsStatus = "reversed"` - `const FundingEventListParamsStatusValidating FundingEventListParamsStatus = "validating"` - `StatusReason param.Field[[]string]` Query param: Reason for latest payment status change. - `const FundingEventListParamsStatusReasonInsufficientFunds FundingEventListParamsStatusReason = "insufficient_funds"` - `const FundingEventListParamsStatusReasonClosedBankAccount FundingEventListParamsStatusReason = "closed_bank_account"` - `const FundingEventListParamsStatusReasonInvalidBankAccount FundingEventListParamsStatusReason = "invalid_bank_account"` - `const FundingEventListParamsStatusReasonInvalidRouting FundingEventListParamsStatusReason = "invalid_routing"` - `const FundingEventListParamsStatusReasonDisputed FundingEventListParamsStatusReason = "disputed"` - `const FundingEventListParamsStatusReasonPaymentStopped FundingEventListParamsStatusReason = "payment_stopped"` - `const FundingEventListParamsStatusReasonOwnerDeceased FundingEventListParamsStatusReason = "owner_deceased"` - `const FundingEventListParamsStatusReasonFrozenBankAccount FundingEventListParamsStatusReason = "frozen_bank_account"` - `const FundingEventListParamsStatusReasonRiskReview FundingEventListParamsStatusReason = "risk_review"` - `const FundingEventListParamsStatusReasonFraudulent FundingEventListParamsStatusReason = "fraudulent"` - `const FundingEventListParamsStatusReasonDuplicateEntry FundingEventListParamsStatusReason = "duplicate_entry"` - `const FundingEventListParamsStatusReasonInvalidPaykey FundingEventListParamsStatusReason = "invalid_paykey"` - `const FundingEventListParamsStatusReasonPaymentBlocked FundingEventListParamsStatusReason = "payment_blocked"` - `const FundingEventListParamsStatusReasonAmountTooLarge FundingEventListParamsStatusReason = "amount_too_large"` - `const FundingEventListParamsStatusReasonTooManyAttempts FundingEventListParamsStatusReason = "too_many_attempts"` - `const FundingEventListParamsStatusReasonInternalSystemError FundingEventListParamsStatusReason = "internal_system_error"` - `const FundingEventListParamsStatusReasonUserRequest FundingEventListParamsStatusReason = "user_request"` - `const FundingEventListParamsStatusReasonOk FundingEventListParamsStatusReason = "ok"` - `const FundingEventListParamsStatusReasonOtherNetworkReturn FundingEventListParamsStatusReason = "other_network_return"` - `const FundingEventListParamsStatusReasonPayoutRefused FundingEventListParamsStatusReason = "payout_refused"` - `const FundingEventListParamsStatusReasonCancelRequest FundingEventListParamsStatusReason = "cancel_request"` - `const FundingEventListParamsStatusReasonFailedVerification FundingEventListParamsStatusReason = "failed_verification"` - `const FundingEventListParamsStatusReasonRequireReview FundingEventListParamsStatusReason = "require_review"` - `const FundingEventListParamsStatusReasonBlockedBySystem FundingEventListParamsStatusReason = "blocked_by_system"` - `const FundingEventListParamsStatusReasonWatchtowerReview FundingEventListParamsStatusReason = "watchtower_review"` - `const FundingEventListParamsStatusReasonValidating FundingEventListParamsStatusReason = "validating"` - `const FundingEventListParamsStatusReasonAutoHold FundingEventListParamsStatusReason = "auto_hold"` - `StatusSource param.Field[[]string]` Query param: Source of latest payment status change. - `const FundingEventListParamsStatusSourceWatchtower FundingEventListParamsStatusSource = "watchtower"` - `const FundingEventListParamsStatusSourceBankDecline FundingEventListParamsStatusSource = "bank_decline"` - `const FundingEventListParamsStatusSourceCustomerDispute FundingEventListParamsStatusSource = "customer_dispute"` - `const FundingEventListParamsStatusSourceUserAction FundingEventListParamsStatusSource = "user_action"` - `const FundingEventListParamsStatusSourceSystem FundingEventListParamsStatusSource = "system"` - `TraceID param.Field[string]` Query param: Trace Id. - `TraceNumber param.Field[string]` Query param: Trace number. - `CorrelationID param.Field[string]` Header param: Optional client generated identifier to trace and debug a series of requests. - `RequestID param.Field[string]` Header param: Optional client generated identifier to trace and debug a request. - `StraddleAccountID param.Field[string]` Header param: For use by platforms to specify an account id and set scope of a request. ### Returns - `type FundingEventSummaryPagedV1Data struct{…}` - `ID string` Unique identifier for the funding event. - `Amount int64` The amount of the funding event in cents. - `CreatedAt Time` Created at. - `Direction string` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `const FundingEventSummaryPagedV1DataDirectionDeposit FundingEventSummaryPagedV1DataDirection = "deposit"` - `const FundingEventSummaryPagedV1DataDirectionWithdrawal FundingEventSummaryPagedV1DataDirection = "withdrawal"` - `EventType string` The funding event types describes the direction and reason for the funding event. - `const FundingEventSummaryPagedV1DataEventTypeChargeDeposit FundingEventSummaryPagedV1DataEventType = "charge_deposit"` - `const FundingEventSummaryPagedV1DataEventTypeChargeReversal FundingEventSummaryPagedV1DataEventType = "charge_reversal"` - `const FundingEventSummaryPagedV1DataEventTypePayoutReturn FundingEventSummaryPagedV1DataEventType = "payout_return"` - `const FundingEventSummaryPagedV1DataEventTypePayoutWithdrawal FundingEventSummaryPagedV1DataEventType = "payout_withdrawal"` - `PaymentCount int64` The number of payments associated with the funding event. - `TraceIDs map[string, string]` Trace Ids. - `TraceNumbers []string` Trace number. - `TransferDate Time` 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. - `UpdatedAt Time` Updated at. - `Status string` The current status of the `charge` or `payout`. - `const FundingEventSummaryPagedV1DataStatusCreated FundingEventSummaryPagedV1DataStatus = "created"` - `const FundingEventSummaryPagedV1DataStatusScheduled FundingEventSummaryPagedV1DataStatus = "scheduled"` - `const FundingEventSummaryPagedV1DataStatusFailed FundingEventSummaryPagedV1DataStatus = "failed"` - `const FundingEventSummaryPagedV1DataStatusCancelled FundingEventSummaryPagedV1DataStatus = "cancelled"` - `const FundingEventSummaryPagedV1DataStatusOnHold FundingEventSummaryPagedV1DataStatus = "on_hold"` - `const FundingEventSummaryPagedV1DataStatusPending FundingEventSummaryPagedV1DataStatus = "pending"` - `const FundingEventSummaryPagedV1DataStatusPaid FundingEventSummaryPagedV1DataStatus = "paid"` - `const FundingEventSummaryPagedV1DataStatusReversed FundingEventSummaryPagedV1DataStatus = "reversed"` - `const FundingEventSummaryPagedV1DataStatusValidating FundingEventSummaryPagedV1DataStatus = "validating"` - `StatusDetails FundingEventSummaryPagedV1DataStatusDetails` - `ChangedAt Time` The time the status change occurred. - `Message string` A human-readable description of the current status. - `Reason string` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonInsufficientFunds FundingEventSummaryPagedV1DataStatusDetailsReason = "insufficient_funds"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonClosedBankAccount FundingEventSummaryPagedV1DataStatusDetailsReason = "closed_bank_account"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonInvalidBankAccount FundingEventSummaryPagedV1DataStatusDetailsReason = "invalid_bank_account"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonInvalidRouting FundingEventSummaryPagedV1DataStatusDetailsReason = "invalid_routing"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonDisputed FundingEventSummaryPagedV1DataStatusDetailsReason = "disputed"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonPaymentStopped FundingEventSummaryPagedV1DataStatusDetailsReason = "payment_stopped"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonOwnerDeceased FundingEventSummaryPagedV1DataStatusDetailsReason = "owner_deceased"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonFrozenBankAccount FundingEventSummaryPagedV1DataStatusDetailsReason = "frozen_bank_account"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonRiskReview FundingEventSummaryPagedV1DataStatusDetailsReason = "risk_review"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonFraudulent FundingEventSummaryPagedV1DataStatusDetailsReason = "fraudulent"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonDuplicateEntry FundingEventSummaryPagedV1DataStatusDetailsReason = "duplicate_entry"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonInvalidPaykey FundingEventSummaryPagedV1DataStatusDetailsReason = "invalid_paykey"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonPaymentBlocked FundingEventSummaryPagedV1DataStatusDetailsReason = "payment_blocked"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonAmountTooLarge FundingEventSummaryPagedV1DataStatusDetailsReason = "amount_too_large"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonTooManyAttempts FundingEventSummaryPagedV1DataStatusDetailsReason = "too_many_attempts"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonInternalSystemError FundingEventSummaryPagedV1DataStatusDetailsReason = "internal_system_error"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonUserRequest FundingEventSummaryPagedV1DataStatusDetailsReason = "user_request"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonOk FundingEventSummaryPagedV1DataStatusDetailsReason = "ok"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonOtherNetworkReturn FundingEventSummaryPagedV1DataStatusDetailsReason = "other_network_return"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonPayoutRefused FundingEventSummaryPagedV1DataStatusDetailsReason = "payout_refused"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonCancelRequest FundingEventSummaryPagedV1DataStatusDetailsReason = "cancel_request"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonFailedVerification FundingEventSummaryPagedV1DataStatusDetailsReason = "failed_verification"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonRequireReview FundingEventSummaryPagedV1DataStatusDetailsReason = "require_review"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonBlockedBySystem FundingEventSummaryPagedV1DataStatusDetailsReason = "blocked_by_system"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonWatchtowerReview FundingEventSummaryPagedV1DataStatusDetailsReason = "watchtower_review"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonValidating FundingEventSummaryPagedV1DataStatusDetailsReason = "validating"` - `const FundingEventSummaryPagedV1DataStatusDetailsReasonAutoHold FundingEventSummaryPagedV1DataStatusDetailsReason = "auto_hold"` - `Source string` - `const FundingEventSummaryPagedV1DataStatusDetailsSourceWatchtower FundingEventSummaryPagedV1DataStatusDetailsSource = "watchtower"` - `const FundingEventSummaryPagedV1DataStatusDetailsSourceBankDecline FundingEventSummaryPagedV1DataStatusDetailsSource = "bank_decline"` - `const FundingEventSummaryPagedV1DataStatusDetailsSourceCustomerDispute FundingEventSummaryPagedV1DataStatusDetailsSource = "customer_dispute"` - `const FundingEventSummaryPagedV1DataStatusDetailsSourceUserAction FundingEventSummaryPagedV1DataStatusDetailsSource = "user_action"` - `const FundingEventSummaryPagedV1DataStatusDetailsSourceSystem FundingEventSummaryPagedV1DataStatusDetailsSource = "system"` - `Code string` The status code if applicable. - `TraceNumber string` The trace number of the funding event. ### Example ```go package main import ( "context" "fmt" "github.com/straddleio/straddle-go" "github.com/straddleio/straddle-go/option" ) func main() { client := straddle.NewClient( option.WithAPIKey("My API Key"), ) page, err := client.FundingEvents.List(context.TODO(), straddle.FundingEventListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "amount": 100000, "created_at": "2019-12-27T18:11:19.117Z", "direction": "deposit", "event_type": "charge_deposit", "payment_count": 0, "trace_ids": { "foo": "string" }, "trace_numbers": [ "string" ], "transfer_date": "2019-12-27", "updated_at": "2019-12-27T18:11:19.117Z", "status": "created", "status_details": { "changed_at": "2019-12-27T18:11:19.117Z", "message": "Bank account sucesfully validated", "reason": "insufficient_funds", "source": "watchtower", "code": "code" }, "trace_number": "trace_number" } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ```