List funding events

funding_events.list(**kwargs) -> PageNumberSchema<{ id, amount, created_at, 10 more}>

get/v1/funding_events

Retrieves a list of funding events for your account. This endpoint supports advanced sorting and filtering options.

ParametersExpand Collapse

created_from: Date

The start date of the range to filter by using the YYYY-MM-DD format.

formatdate

created_to: Date

The end date of the range to filter by using the YYYY-MM-DD format.

formatdate

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

page_number: Integer

Results page number. Starts at page 1.

formatint32

page_size: Integer

Results page size. Max value: 1000

formatint32

search_text: String

Search text.

sort_by: :transfer_date | :id | :amount

The field to sort the results by.

Accepts one of the following:

:transfer_date

:id

:amount

sort_order: :asc | :desc

The order in which to sort the results.

Accepts one of the following:

:asc

:desc

status: Array[:created | :scheduled | :failed | 5 more]

Funding Event status.

Accepts one of the following:

:created

:scheduled

:failed

:cancelled

:on_hold

:pending

:paid

:reversed

status_reason: Array[:insufficient_funds | :closed_bank_account | :invalid_bank_account | 22 more]

Reason for latest payment status change.

Accepts one of the following:

: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

status_source: Array[:watchtower | :bank_decline | :customer_dispute | 2 more]

Source of latest payment status change.

Accepts one of the following:

:watchtower

:bank_decline

:customer_dispute

:user_action

:system

trace_id: String

Trace Id.

trace_number: String

Trace number.

correlation_id: String

request_id: String

straddle_account_id: String

ReturnsExpand Collapse

{ id, amount, created_at, 10 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

status: :created | :scheduled | :failed | 5 more

The current status of the charge or payout.

Accepts one of the following:

:created

:scheduled

:failed

:cancelled

:on_hold

:pending

:paid

:reversed

status_details: { changed_at, message, reason, 2 more}

changed_at: Time

The time the status change occurred.

formatdate-time

message: String

A human-readable description of the current status.

reason: :insufficient_funds | :closed_bank_account | :invalid_bank_account | 22 more

Accepts one of the following:

: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

source: :watchtower | :bank_decline | :customer_dispute | 2 more

Accepts one of the following:

:watchtower

:bank_decline

:customer_dispute

:user_action

:system

code: String

The status code if applicable.

trace_number: String

The trace number of the funding event.

List funding events

require "straddle"

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

page = straddle.funding_events.list

puts(page)

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

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