ECecommerceapi

Get a specific payout

Retrieves a single payout by ID.

get/shopwired-payments/payouts/{payout_id}

Request

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

Path parameters

payout_idstring required

The unique identifier of the payout.

Query parameters

fieldsstring

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

Response

The payout details.

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.