## Lookup a funding event `client.fundingEvents.get(stringid, FundingEventGetParamsparams?, RequestOptionsoptions?): FundingEventSummaryItemV1` **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` - `params: FundingEventGetParams` - `correlationID?: string` Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Optional client generated identifier to trace and debug a request. - `straddleAccountID?: string` For use by platforms to specify an account id and set scope of a request. ### Returns - `FundingEventSummaryItemV1` - `data: Data` - `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" | "withdrawal"` Describes the direction of the funding event from the perspective of the `linked_bank_account`. - `"deposit"` - `"withdrawal"` - `event_type: "charge_deposit" | "charge_reversal" | "payout_return" | "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: Record` Trace Ids. - `trace_numbers: Array` 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?: "created" | "scheduled" | "failed" | 6 more` The current status of the `charge` or `payout`. - `"created"` - `"scheduled"` - `"failed"` - `"cancelled"` - `"on_hold"` - `"pending"` - `"paid"` - `"reversed"` - `"validating"` - `status_details?: StatusDetails` - `changed_at: string` The time the status change occurred. - `message: string` A human-readable description of the current status. - `reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 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" | "bank_decline" | "customer_dispute" | 2 more` - `"watchtower"` - `"bank_decline"` - `"customer_dispute"` - `"user_action"` - `"system"` - `code?: string | null` The status code if applicable. - `trace_number?: string | null` The trace number of the funding event. - `meta: ResponseMetadata` 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" | "array" | "error" | "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 ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const fundingEventSummaryItemV1 = await client.fundingEvents.get( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(fundingEventSummaryItemV1.data); ``` #### 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" } ```