# Funding Events ## List funding events `FundingEventSummaryPagedV1 FundingEvents.List(FundingEventListParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/funding_events` Retrieves a list of funding events for your account. This endpoint supports advanced sorting and filtering options. ### Parameters - `FundingEventListParams parameters` - `DateOnly? createdFrom` Query param: The start date of the range to filter by using the `YYYY-MM-DD` format. - `DateOnly? createdTo` Query param: The end date of the range to filter by using the `YYYY-MM-DD` format. - `Direction direction` Query param: Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"Deposit` - `"withdrawal"Withdrawal` - `EventType eventType` Query param: The funding event types describes the direction and reason for the funding event. - `"charge_deposit"ChargeDeposit` - `"charge_reversal"ChargeReversal` - `"payout_return"PayoutReturn` - `"payout_withdrawal"PayoutWithdrawal` - `Int pageNumber` Query param: Results page number. Starts at page 1. - `Int pageSize` Query param: Results page size. Max value: 1000 - `string? searchText` Query param: Search text. - `SortBy sortBy` Query param: The field to sort the results by. - `"transfer_date"TransferDate` - `"id"ID` - `"amount"Amount` - `SortOrder sortOrder` Query param: The order in which to sort the results. - `"asc"Asc` - `"desc"Desc` - `IReadOnlyList? status` Query param: Funding Event status. - `"created"Created` - `"scheduled"Scheduled` - `"failed"Failed` - `"cancelled"Cancelled` - `"on_hold"OnHold` - `"pending"Pending` - `"paid"Paid` - `"reversed"Reversed` - `"validating"Validating` - `IReadOnlyList? statusReason` Query param: Reason for latest payment status change. - `"insufficient_funds"InsufficientFunds` - `"closed_bank_account"ClosedBankAccount` - `"invalid_bank_account"InvalidBankAccount` - `"invalid_routing"InvalidRouting` - `"disputed"Disputed` - `"payment_stopped"PaymentStopped` - `"owner_deceased"OwnerDeceased` - `"frozen_bank_account"FrozenBankAccount` - `"risk_review"RiskReview` - `"fraudulent"Fraudulent` - `"duplicate_entry"DuplicateEntry` - `"invalid_paykey"InvalidPaykey` - `"payment_blocked"PaymentBlocked` - `"amount_too_large"AmountTooLarge` - `"too_many_attempts"TooManyAttempts` - `"internal_system_error"InternalSystemError` - `"user_request"UserRequest` - `"ok"Ok` - `"other_network_return"OtherNetworkReturn` - `"payout_refused"PayoutRefused` - `"cancel_request"CancelRequest` - `"failed_verification"FailedVerification` - `"require_review"RequireReview` - `"blocked_by_system"BlockedBySystem` - `"watchtower_review"WatchtowerReview` - `"validating"Validating` - `"auto_hold"AutoHold` - `IReadOnlyList? statusSource` Query param: Source of latest payment status change. - `"watchtower"Watchtower` - `"bank_decline"BankDecline` - `"customer_dispute"CustomerDispute` - `"user_action"UserAction` - `"system"System` - `string? traceID` Query param: Trace Id. - `string? traceNumber` Query param: Trace number. - `string correlationID` Header param: Optional client generated identifier to trace and debug a series of requests. - `string requestID` Header param: Optional client generated identifier to trace and debug a request. - `string straddleAccountID` Header param: For use by platforms to specify an account id and set scope of a request. ### Returns - `class FundingEventSummaryPagedV1:` - `required IReadOnlyList Data` - `required string ID` Unique identifier for the funding event. - `required Int Amount` The amount of the funding event in cents. - `required DateTimeOffset CreatedAt` Created at. - `required Direction Direction` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"Deposit` - `"withdrawal"Withdrawal` - `required EventType EventType` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"ChargeDeposit` - `"charge_reversal"ChargeReversal` - `"payout_return"PayoutReturn` - `"payout_withdrawal"PayoutWithdrawal` - `required Int PaymentCount` The number of payments associated with the funding event. - `required IReadOnlyDictionary TraceIds` Trace Ids. - `required IReadOnlyList TraceNumbers` Trace number. - `required DateOnly TransferDate` 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. - `required DateTimeOffset UpdatedAt` Updated at. - `Status Status` The current status of the `charge` or `payout`. - `"created"Created` - `"scheduled"Scheduled` - `"failed"Failed` - `"cancelled"Cancelled` - `"on_hold"OnHold` - `"pending"Pending` - `"paid"Paid` - `"reversed"Reversed` - `"validating"Validating` - `StatusDetails StatusDetails` - `required DateTimeOffset ChangedAt` The time the status change occurred. - `required string Message` A human-readable description of the current status. - `required Reason Reason` - `"insufficient_funds"InsufficientFunds` - `"closed_bank_account"ClosedBankAccount` - `"invalid_bank_account"InvalidBankAccount` - `"invalid_routing"InvalidRouting` - `"disputed"Disputed` - `"payment_stopped"PaymentStopped` - `"owner_deceased"OwnerDeceased` - `"frozen_bank_account"FrozenBankAccount` - `"risk_review"RiskReview` - `"fraudulent"Fraudulent` - `"duplicate_entry"DuplicateEntry` - `"invalid_paykey"InvalidPaykey` - `"payment_blocked"PaymentBlocked` - `"amount_too_large"AmountTooLarge` - `"too_many_attempts"TooManyAttempts` - `"internal_system_error"InternalSystemError` - `"user_request"UserRequest` - `"ok"Ok` - `"other_network_return"OtherNetworkReturn` - `"payout_refused"PayoutRefused` - `"cancel_request"CancelRequest` - `"failed_verification"FailedVerification` - `"require_review"RequireReview` - `"blocked_by_system"BlockedBySystem` - `"watchtower_review"WatchtowerReview` - `"validating"Validating` - `"auto_hold"AutoHold` - `required Source Source` - `"watchtower"Watchtower` - `"bank_decline"BankDecline` - `"customer_dispute"CustomerDispute` - `"user_action"UserAction` - `"system"System` - `string? Code` The status code if applicable. - `string? TraceNumber` The trace number of the funding event. - `required Meta Meta` - `required string ApiRequestID` Unique identifier for this API request, useful for troubleshooting. - `required DateTimeOffset ApiRequestTimestamp` Timestamp for this API request, useful for troubleshooting. - `required Int MaxPageSize` Maximum allowed page size for this endpoint. - `required Int PageNumber` Page number for paginated results. - `required Int PageSize` Number of items per page in this response. - `required string SortBy` The field that the results were sorted by. - `required SortOrder SortOrder` - `"asc"Asc` - `"desc"Desc` - `required Int TotalItems` - `required Int TotalPages` The number of pages available. - `required ResponseType ResponseType` 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. - `"object"Object` - `"array"Array` - `"error"Error` - `"none"None` ### Example ```csharp FundingEventListParams parameters = new(); var page = await client.FundingEvents.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` #### 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" } ``` ## Lookup a funding event `FundingEventSummaryItemV1 FundingEvents.Get(FundingEventGetParamsparameters, CancellationTokencancellationToken = default)` **get** `/v1/funding_events/{id}` Retrieves the details of an existing funding event. Supply the unique funding event `id`, and Straddle will return the individual transaction items that make up the funding event. ### Parameters - `FundingEventGetParams parameters` - `required string id` - `string correlationID` Optional client generated identifier to trace and debug a series of requests. - `string requestID` Optional client generated identifier to trace and debug a request. - `string straddleAccountID` For use by platforms to specify an account id and set scope of a request. ### Returns - `class FundingEventSummaryItemV1:` - `required Data Data` - `required string ID` Unique identifier for the funding event. - `required Int Amount` The amount of the funding event in cents. - `required DateTimeOffset CreatedAt` Created at. - `required Direction Direction` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"Deposit` - `"withdrawal"Withdrawal` - `required EventType EventType` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"ChargeDeposit` - `"charge_reversal"ChargeReversal` - `"payout_return"PayoutReturn` - `"payout_withdrawal"PayoutWithdrawal` - `required Int PaymentCount` The number of payments associated with the funding event. - `required IReadOnlyDictionary TraceIds` Trace Ids. - `required IReadOnlyList TraceNumbers` Trace number. - `required DateOnly TransferDate` 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. - `required DateTimeOffset UpdatedAt` Updated at. - `Status Status` The current status of the `charge` or `payout`. - `"created"Created` - `"scheduled"Scheduled` - `"failed"Failed` - `"cancelled"Cancelled` - `"on_hold"OnHold` - `"pending"Pending` - `"paid"Paid` - `"reversed"Reversed` - `"validating"Validating` - `StatusDetails StatusDetails` - `required DateTimeOffset ChangedAt` The time the status change occurred. - `required string Message` A human-readable description of the current status. - `required Reason Reason` - `"insufficient_funds"InsufficientFunds` - `"closed_bank_account"ClosedBankAccount` - `"invalid_bank_account"InvalidBankAccount` - `"invalid_routing"InvalidRouting` - `"disputed"Disputed` - `"payment_stopped"PaymentStopped` - `"owner_deceased"OwnerDeceased` - `"frozen_bank_account"FrozenBankAccount` - `"risk_review"RiskReview` - `"fraudulent"Fraudulent` - `"duplicate_entry"DuplicateEntry` - `"invalid_paykey"InvalidPaykey` - `"payment_blocked"PaymentBlocked` - `"amount_too_large"AmountTooLarge` - `"too_many_attempts"TooManyAttempts` - `"internal_system_error"InternalSystemError` - `"user_request"UserRequest` - `"ok"Ok` - `"other_network_return"OtherNetworkReturn` - `"payout_refused"PayoutRefused` - `"cancel_request"CancelRequest` - `"failed_verification"FailedVerification` - `"require_review"RequireReview` - `"blocked_by_system"BlockedBySystem` - `"watchtower_review"WatchtowerReview` - `"validating"Validating` - `"auto_hold"AutoHold` - `required Source Source` - `"watchtower"Watchtower` - `"bank_decline"BankDecline` - `"customer_dispute"CustomerDispute` - `"user_action"UserAction` - `"system"System` - `string? Code` The status code if applicable. - `string? TraceNumber` The trace number of the funding event. - `required ResponseMetadata Meta` Metadata about the API request, including an identifier and timestamp. - `required string ApiRequestID` Unique identifier for this API request, useful for troubleshooting. - `required DateTimeOffset ApiRequestTimestamp` Timestamp for this API request, useful for troubleshooting. - `required ResponseType ResponseType` 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. - `"object"Object` - `"array"Array` - `"error"Error` - `"none"None` ### Example ```csharp FundingEventGetParams parameters = new() { ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }; var fundingEventSummaryItemV1 = await client.FundingEvents.Get(parameters); Console.WriteLine(fundingEventSummaryItemV1); ``` #### 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" }, "response_type": "object" } ``` ## Domain Types ### Funding Event Summary Item V1 - `class FundingEventSummaryItemV1:` - `required Data Data` - `required string ID` Unique identifier for the funding event. - `required Int Amount` The amount of the funding event in cents. - `required DateTimeOffset CreatedAt` Created at. - `required Direction Direction` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"Deposit` - `"withdrawal"Withdrawal` - `required EventType EventType` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"ChargeDeposit` - `"charge_reversal"ChargeReversal` - `"payout_return"PayoutReturn` - `"payout_withdrawal"PayoutWithdrawal` - `required Int PaymentCount` The number of payments associated with the funding event. - `required IReadOnlyDictionary TraceIds` Trace Ids. - `required IReadOnlyList TraceNumbers` Trace number. - `required DateOnly TransferDate` 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. - `required DateTimeOffset UpdatedAt` Updated at. - `Status Status` The current status of the `charge` or `payout`. - `"created"Created` - `"scheduled"Scheduled` - `"failed"Failed` - `"cancelled"Cancelled` - `"on_hold"OnHold` - `"pending"Pending` - `"paid"Paid` - `"reversed"Reversed` - `"validating"Validating` - `StatusDetails StatusDetails` - `required DateTimeOffset ChangedAt` The time the status change occurred. - `required string Message` A human-readable description of the current status. - `required Reason Reason` - `"insufficient_funds"InsufficientFunds` - `"closed_bank_account"ClosedBankAccount` - `"invalid_bank_account"InvalidBankAccount` - `"invalid_routing"InvalidRouting` - `"disputed"Disputed` - `"payment_stopped"PaymentStopped` - `"owner_deceased"OwnerDeceased` - `"frozen_bank_account"FrozenBankAccount` - `"risk_review"RiskReview` - `"fraudulent"Fraudulent` - `"duplicate_entry"DuplicateEntry` - `"invalid_paykey"InvalidPaykey` - `"payment_blocked"PaymentBlocked` - `"amount_too_large"AmountTooLarge` - `"too_many_attempts"TooManyAttempts` - `"internal_system_error"InternalSystemError` - `"user_request"UserRequest` - `"ok"Ok` - `"other_network_return"OtherNetworkReturn` - `"payout_refused"PayoutRefused` - `"cancel_request"CancelRequest` - `"failed_verification"FailedVerification` - `"require_review"RequireReview` - `"blocked_by_system"BlockedBySystem` - `"watchtower_review"WatchtowerReview` - `"validating"Validating` - `"auto_hold"AutoHold` - `required Source Source` - `"watchtower"Watchtower` - `"bank_decline"BankDecline` - `"customer_dispute"CustomerDispute` - `"user_action"UserAction` - `"system"System` - `string? Code` The status code if applicable. - `string? TraceNumber` The trace number of the funding event. - `required ResponseMetadata Meta` Metadata about the API request, including an identifier and timestamp. - `required string ApiRequestID` Unique identifier for this API request, useful for troubleshooting. - `required DateTimeOffset ApiRequestTimestamp` Timestamp for this API request, useful for troubleshooting. - `required ResponseType ResponseType` 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. - `"object"Object` - `"array"Array` - `"error"Error` - `"none"None` ### Funding Event Summary Paged V1 - `class FundingEventSummaryPagedV1:` - `required IReadOnlyList Data` - `required string ID` Unique identifier for the funding event. - `required Int Amount` The amount of the funding event in cents. - `required DateTimeOffset CreatedAt` Created at. - `required Direction Direction` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"Deposit` - `"withdrawal"Withdrawal` - `required EventType EventType` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"ChargeDeposit` - `"charge_reversal"ChargeReversal` - `"payout_return"PayoutReturn` - `"payout_withdrawal"PayoutWithdrawal` - `required Int PaymentCount` The number of payments associated with the funding event. - `required IReadOnlyDictionary TraceIds` Trace Ids. - `required IReadOnlyList TraceNumbers` Trace number. - `required DateOnly TransferDate` 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. - `required DateTimeOffset UpdatedAt` Updated at. - `Status Status` The current status of the `charge` or `payout`. - `"created"Created` - `"scheduled"Scheduled` - `"failed"Failed` - `"cancelled"Cancelled` - `"on_hold"OnHold` - `"pending"Pending` - `"paid"Paid` - `"reversed"Reversed` - `"validating"Validating` - `StatusDetails StatusDetails` - `required DateTimeOffset ChangedAt` The time the status change occurred. - `required string Message` A human-readable description of the current status. - `required Reason Reason` - `"insufficient_funds"InsufficientFunds` - `"closed_bank_account"ClosedBankAccount` - `"invalid_bank_account"InvalidBankAccount` - `"invalid_routing"InvalidRouting` - `"disputed"Disputed` - `"payment_stopped"PaymentStopped` - `"owner_deceased"OwnerDeceased` - `"frozen_bank_account"FrozenBankAccount` - `"risk_review"RiskReview` - `"fraudulent"Fraudulent` - `"duplicate_entry"DuplicateEntry` - `"invalid_paykey"InvalidPaykey` - `"payment_blocked"PaymentBlocked` - `"amount_too_large"AmountTooLarge` - `"too_many_attempts"TooManyAttempts` - `"internal_system_error"InternalSystemError` - `"user_request"UserRequest` - `"ok"Ok` - `"other_network_return"OtherNetworkReturn` - `"payout_refused"PayoutRefused` - `"cancel_request"CancelRequest` - `"failed_verification"FailedVerification` - `"require_review"RequireReview` - `"blocked_by_system"BlockedBySystem` - `"watchtower_review"WatchtowerReview` - `"validating"Validating` - `"auto_hold"AutoHold` - `required Source Source` - `"watchtower"Watchtower` - `"bank_decline"BankDecline` - `"customer_dispute"CustomerDispute` - `"user_action"UserAction` - `"system"System` - `string? Code` The status code if applicable. - `string? TraceNumber` The trace number of the funding event. - `required Meta Meta` - `required string ApiRequestID` Unique identifier for this API request, useful for troubleshooting. - `required DateTimeOffset ApiRequestTimestamp` Timestamp for this API request, useful for troubleshooting. - `required Int MaxPageSize` Maximum allowed page size for this endpoint. - `required Int PageNumber` Page number for paginated results. - `required Int PageSize` Number of items per page in this response. - `required string SortBy` The field that the results were sorted by. - `required SortOrder SortOrder` - `"asc"Asc` - `"desc"Desc` - `required Int TotalItems` - `required Int TotalPages` The number of pages available. - `required ResponseType ResponseType` 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. - `"object"Object` - `"array"Array` - `"error"Error` - `"none"None`