Lookup a funding event

funding_events.get(id, **kwargs) -> FundingEventSummaryItemV1 { data, meta, response_type }

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.

ParametersExpand Collapse

id: String

correlation_id: String

request_id: String

straddle_account_id: String

ReturnsExpand Collapse

class FundingEventSummaryItemV1 { data, meta, response_type }

data: { id, amount, created_at, 8 more}

id: String

Unique identifier for the funding event.

formatuuid

amount: Integer

The amount of the funding event in cents.

formatint32

created_at: Time

Created at.

formatdate-time

direction: :deposit | :withdrawal

Describes the direction of the funding event from the perspective of the linked_bank_account.

Accepts one of the following:

: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.

Accepts one of the following:

:charge_deposit

:charge_reversal

:payout_return

:payout_withdrawal

payment_count: Integer

The number of payments associated with the funding event.

formatint32

trace_ids: Hash[Symbol, String]

Trace Ids.

trace_numbers: Array[String]

Trace number.

transfer_date: Date

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.

formatdate

updated_at: Time

Updated at.

formatdate-time

trace_number: String

The trace number of the funding event.

meta: ResponseMetadata { 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.

formatuuid

api_request_timestamp: Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

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.

Accepts one of the following:

:object

:array

:error

:none

Lookup a funding event

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

funding_event_summary_item_v1 = straddle.funding_events.get("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(funding_event_summary_item_v1)

{
  "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",
    "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"
}

Returns Examples

{
  "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",
    "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"
}