List funding events

FundingEventSummaryPagedV1 FundingEvents.List(, )

GET/v1/funding_events

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

ParametersExpand Collapse

FundingEventListParams parameters

DateOnly? createdFrom

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

formatdate

DateOnly? createdTo

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

formatdate

Direction direction

Query param: Describes the direction of the funding event from the perspective of the linked_bank_account.

EventType eventType

Query param: The funding event types describes the direction and reason for the funding event.

Int pageNumber

Query param: Results page number. Starts at page 1.

formatint32

Int pageSize

Query param: Results page size. Max value: 1000

formatint32

string? searchText

Query param: Search text.

SortBy sortBy

Query param: The field to sort the results by.

SortOrder sortOrder

Query param: The order in which to sort the results.

IReadOnlyList<Status>? status

Query param: Funding Event status.

IReadOnlyList<StatusReason>? statusReason

Query param: Reason for latest payment status change.

IReadOnlyList<StatusSource>? statusSource

Query param: Source of latest payment status change.

string? traceID

Query param: Trace Id.

string? traceNumber

Query param: Trace number.

string correlationID

Header param: Optional client generated identifier to trace and debug a series of requests.

string requestID

Header param: Optional client generated identifier to trace and debug a request.

string straddleAccountID

Header param: For use by platforms to specify an account id and set scope of a request.

formatuuid

ReturnsExpand Collapse

class FundingEventSummaryPagedV1:

required IReadOnlyList<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 Meta Meta

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 Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32

required Int PageNumber

Page number for paginated results.

formatint32

required Int PageSize

Number of items per page in this response.

formatint32

required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder

One of the following:

required Int TotalItems

required Int TotalPages

The number of pages available.

formatint32

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:

List funding events

FundingEventListParams parameters = new();

var page = await client.FundingEvents.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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