Lookup a funding event

FundingEventSummaryItemV1 FundingEvents.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.

ParametersExpand Collapse

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.

formatuuid

ReturnsExpand Collapse

class FundingEventSummaryItemV1:

required Data Data

required string ID

Unique identifier for the funding event.

formatuuid

required Int Amount

The amount of the funding event in cents.

formatint32

required DateTimeOffset CreatedAt

Created at.

formatdate-time

required Direction Direction

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

One of the following:

required EventType EventType

The funding event types describes the direction and reason for the funding event.

One of the following:

required Int PaymentCount

The number of payments associated with the funding event.

formatint32

required IReadOnlyDictionary<string, string> TraceIds

Trace Ids.

required IReadOnlyList<string> 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.

formatdate

required DateTimeOffset UpdatedAt

Updated at.

formatdate-time

Status Status

The current status of the charge or payout.

One of the following:

StatusDetails StatusDetails

required DateTimeOffset ChangedAt

The time the status change occurred.

formatdate-time

required string Message

A human-readable description of the current status.

required Reason Reason

One of the following:

required Source Source

One of the following:

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.

formatuuid

required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time

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.

One of the following:

Lookup a funding event

FundingEventGetParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var fundingEventSummaryItemV1 = await client.FundingEvents.Get(parameters);

Console.WriteLine(fundingEventSummaryItemV1);

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

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"
  },
  "response_type": "object"
}