# Funding Events ## List funding events `$ straddle funding-events list` **get** `/v1/funding_events` Retrieves a list of funding events for your account. This endpoint supports advanced sorting and filtering options. ### Parameters - `--created-from: optional string` Query param: The start date of the range to filter by using the `YYYY-MM-DD` format. - `--created-to: optional string` Query param: The end date of the range to filter by using the `YYYY-MM-DD` format. - `--direction: optional "deposit" or "withdrawal"` Query param: Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `--event-type: optional "charge_deposit" or "charge_reversal" or "payout_return" or "payout_withdrawal"` Query param: The funding event types describes the direction and reason for the funding event. - `--page-number: optional number` Query param: Results page number. Starts at page 1. - `--page-size: optional number` Query param: Results page size. Max value: 1000 - `--search-text: optional string` Query param: Search text. - `--sort-by: optional "transfer_date" or "id" or "amount"` Query param: The field to sort the results by. - `--sort-order: optional "asc" or "desc"` Query param: The order in which to sort the results. - `--status: optional array of "created" or "scheduled" or "failed" or 6 more` Query param: Funding Event status. - `--status-reason: optional array of "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more` Query param: Reason for latest payment status change. - `--status-source: optional array of "watchtower" or "bank_decline" or "customer_dispute" or 2 more` Query param: Source of latest payment status change. - `--trace-id: optional string` Query param: Trace Id. - `--trace-number: optional string` Query param: Trace number. - `--correlation-id: optional string` Header param: Optional client generated identifier to trace and debug a series of requests. - `--request-id: optional string` Header param: Optional client generated identifier to trace and debug a request. - `--straddle-account-id: optional string` Header param: For use by platforms to specify an account id and set scope of a request. ### Returns - `fundingEventSummaryPagedV1: object { data, meta, response_type }` - `data: array of object { id, amount, created_at, 10 more }` - `id: string` Unique identifier for the funding event. - `amount: number` The amount of the funding event in cents. - `created_at: string` Created at. - `direction: "deposit" or "withdrawal"` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"` - `"withdrawal"` - `event_type: "charge_deposit" or "charge_reversal" or "payout_return" or "payout_withdrawal"` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"` - `"charge_reversal"` - `"payout_return"` - `"payout_withdrawal"` - `payment_count: number` The number of payments associated with the funding event. - `trace_ids: map[string]` Trace Ids. - `trace_numbers: array of 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. - `updated_at: string` Updated at. - `status: optional "created" or "scheduled" or "failed" or 6 more` The current status of the `charge` or `payout`. - `"created"` - `"scheduled"` - `"failed"` - `"cancelled"` - `"on_hold"` - `"pending"` - `"paid"` - `"reversed"` - `"validating"` - `status_details: optional object { changed_at, message, reason, 2 more }` - `changed_at: string` The time the status change occurred. - `message: string` A human-readable description of the current status. - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more` - `"insufficient_funds"` - `"closed_bank_account"` - `"invalid_bank_account"` - `"invalid_routing"` - `"disputed"` - `"payment_stopped"` - `"owner_deceased"` - `"frozen_bank_account"` - `"risk_review"` - `"fraudulent"` - `"duplicate_entry"` - `"invalid_paykey"` - `"payment_blocked"` - `"amount_too_large"` - `"too_many_attempts"` - `"internal_system_error"` - `"user_request"` - `"ok"` - `"other_network_return"` - `"payout_refused"` - `"cancel_request"` - `"failed_verification"` - `"require_review"` - `"blocked_by_system"` - `"watchtower_review"` - `"validating"` - `"auto_hold"` - `source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more` - `"watchtower"` - `"bank_decline"` - `"customer_dispute"` - `"user_action"` - `"system"` - `code: optional string` The status code if applicable. - `trace_number: optional string` The trace number of the funding event. - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }` - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" or "desc"` - `"asc"` - `"desc"` - `total_items: number` - `total_pages: number` The number of pages available. - `response_type: "object" or "array" or "error" or "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```cli straddle funding-events list \ --api-key 'My API Key' ``` #### 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 `$ straddle funding-events get` **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 - `--id: string` - `--correlation-id: optional string` Optional client generated identifier to trace and debug a series of requests. - `--request-id: optional string` Optional client generated identifier to trace and debug a request. - `--straddle-account-id: optional string` For use by platforms to specify an account id and set scope of a request. ### Returns - `fundingEventSummaryItemV1: object { data, meta, response_type }` - `data: object { id, amount, created_at, 10 more }` - `id: string` Unique identifier for the funding event. - `amount: number` The amount of the funding event in cents. - `created_at: string` Created at. - `direction: "deposit" or "withdrawal"` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"` - `"withdrawal"` - `event_type: "charge_deposit" or "charge_reversal" or "payout_return" or "payout_withdrawal"` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"` - `"charge_reversal"` - `"payout_return"` - `"payout_withdrawal"` - `payment_count: number` The number of payments associated with the funding event. - `trace_ids: map[string]` Trace Ids. - `trace_numbers: array of 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. - `updated_at: string` Updated at. - `status: optional "created" or "scheduled" or "failed" or 6 more` The current status of the `charge` or `payout`. - `"created"` - `"scheduled"` - `"failed"` - `"cancelled"` - `"on_hold"` - `"pending"` - `"paid"` - `"reversed"` - `"validating"` - `status_details: optional object { changed_at, message, reason, 2 more }` - `changed_at: string` The time the status change occurred. - `message: string` A human-readable description of the current status. - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more` - `"insufficient_funds"` - `"closed_bank_account"` - `"invalid_bank_account"` - `"invalid_routing"` - `"disputed"` - `"payment_stopped"` - `"owner_deceased"` - `"frozen_bank_account"` - `"risk_review"` - `"fraudulent"` - `"duplicate_entry"` - `"invalid_paykey"` - `"payment_blocked"` - `"amount_too_large"` - `"too_many_attempts"` - `"internal_system_error"` - `"user_request"` - `"ok"` - `"other_network_return"` - `"payout_refused"` - `"cancel_request"` - `"failed_verification"` - `"require_review"` - `"blocked_by_system"` - `"watchtower_review"` - `"validating"` - `"auto_hold"` - `source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more` - `"watchtower"` - `"bank_decline"` - `"customer_dispute"` - `"user_action"` - `"system"` - `code: optional string` The status code if applicable. - `trace_number: optional string` The trace number of the funding event. - `meta: object { 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. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "object" or "array" or "error" or "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```cli straddle funding-events get \ --api-key 'My API Key' \ --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e ``` #### 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 - `fundingEventSummaryItemV1: object { data, meta, response_type }` - `data: object { id, amount, created_at, 10 more }` - `id: string` Unique identifier for the funding event. - `amount: number` The amount of the funding event in cents. - `created_at: string` Created at. - `direction: "deposit" or "withdrawal"` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"` - `"withdrawal"` - `event_type: "charge_deposit" or "charge_reversal" or "payout_return" or "payout_withdrawal"` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"` - `"charge_reversal"` - `"payout_return"` - `"payout_withdrawal"` - `payment_count: number` The number of payments associated with the funding event. - `trace_ids: map[string]` Trace Ids. - `trace_numbers: array of 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. - `updated_at: string` Updated at. - `status: optional "created" or "scheduled" or "failed" or 6 more` The current status of the `charge` or `payout`. - `"created"` - `"scheduled"` - `"failed"` - `"cancelled"` - `"on_hold"` - `"pending"` - `"paid"` - `"reversed"` - `"validating"` - `status_details: optional object { changed_at, message, reason, 2 more }` - `changed_at: string` The time the status change occurred. - `message: string` A human-readable description of the current status. - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more` - `"insufficient_funds"` - `"closed_bank_account"` - `"invalid_bank_account"` - `"invalid_routing"` - `"disputed"` - `"payment_stopped"` - `"owner_deceased"` - `"frozen_bank_account"` - `"risk_review"` - `"fraudulent"` - `"duplicate_entry"` - `"invalid_paykey"` - `"payment_blocked"` - `"amount_too_large"` - `"too_many_attempts"` - `"internal_system_error"` - `"user_request"` - `"ok"` - `"other_network_return"` - `"payout_refused"` - `"cancel_request"` - `"failed_verification"` - `"require_review"` - `"blocked_by_system"` - `"watchtower_review"` - `"validating"` - `"auto_hold"` - `source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more` - `"watchtower"` - `"bank_decline"` - `"customer_dispute"` - `"user_action"` - `"system"` - `code: optional string` The status code if applicable. - `trace_number: optional string` The trace number of the funding event. - `meta: object { 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. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "object" or "array" or "error" or "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Funding Event Summary Paged V1 - `fundingEventSummaryPagedV1: object { data, meta, response_type }` - `data: array of object { id, amount, created_at, 10 more }` - `id: string` Unique identifier for the funding event. - `amount: number` The amount of the funding event in cents. - `created_at: string` Created at. - `direction: "deposit" or "withdrawal"` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"` - `"withdrawal"` - `event_type: "charge_deposit" or "charge_reversal" or "payout_return" or "payout_withdrawal"` The funding event types describes the direction and reason for the funding event. - `"charge_deposit"` - `"charge_reversal"` - `"payout_return"` - `"payout_withdrawal"` - `payment_count: number` The number of payments associated with the funding event. - `trace_ids: map[string]` Trace Ids. - `trace_numbers: array of 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. - `updated_at: string` Updated at. - `status: optional "created" or "scheduled" or "failed" or 6 more` The current status of the `charge` or `payout`. - `"created"` - `"scheduled"` - `"failed"` - `"cancelled"` - `"on_hold"` - `"pending"` - `"paid"` - `"reversed"` - `"validating"` - `status_details: optional object { changed_at, message, reason, 2 more }` - `changed_at: string` The time the status change occurred. - `message: string` A human-readable description of the current status. - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more` - `"insufficient_funds"` - `"closed_bank_account"` - `"invalid_bank_account"` - `"invalid_routing"` - `"disputed"` - `"payment_stopped"` - `"owner_deceased"` - `"frozen_bank_account"` - `"risk_review"` - `"fraudulent"` - `"duplicate_entry"` - `"invalid_paykey"` - `"payment_blocked"` - `"amount_too_large"` - `"too_many_attempts"` - `"internal_system_error"` - `"user_request"` - `"ok"` - `"other_network_return"` - `"payout_refused"` - `"cancel_request"` - `"failed_verification"` - `"require_review"` - `"blocked_by_system"` - `"watchtower_review"` - `"validating"` - `"auto_hold"` - `source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more` - `"watchtower"` - `"bank_decline"` - `"customer_dispute"` - `"user_action"` - `"system"` - `code: optional string` The status code if applicable. - `trace_number: optional string` The trace number of the funding event. - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }` - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" or "desc"` - `"asc"` - `"desc"` - `total_items: number` - `total_pages: number` The number of pages available. - `response_type: "object" or "array" or "error" or "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. - `"object"` - `"array"` - `"error"` - `"none"`