ECecommerceapi

List payouts

Retrieves a list of payouts with pagination.

get/shopwired-payments/payouts

Request

  • Base URL
    https://api.ecommerceapi.uk/v1
  • URL
    https://api.ecommerceapi.uk/v1/shopwired-payments/payouts
  • Auth
    HTTP basic

Query parameters

countinteger

Number of records to retrieve (default: 50, max: 100).

offsetinteger

Number of records to skip.

sort'created' | 'created_asc' | 'created_desc'
Example:created_desc

Sorting order for the results. Defaults to no sorting.

fieldsstring

Comma-separated list of fields to include in the response.

Response

A list of payouts.

idstring

Unique identifier for the payout.

createdAtstring date-time

Timestamp when the payout was created.

status'pending' | 'in_transit' | 'failed' | 'paid'

Current status of the payout.

automaticboolean

Indicates whether the payout was initiated automatically.

expectedBystring date-time

Expected arrival date of the payout.

Changes

No recorded changes to this operation across all 1 revision of this API.