Retrieve a e-commerce payout

Retrieve the information of the payout with the supplied payout ID.

Check the category field from the work platform API response or the "Category" column in this data guide to see which platfroms we serve under "commerce".

Usually used in conjunction with the "PAYOUTS.*" webhooks, read more.

GET /v1/commerce/income/payouts/{id}

Basic auth

curl 'https://api.sandbox.insightiq.ai/v1/commerce/income/payouts/id_01JXY9AZK4KV' \
  --request GET \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2020-03-27T12:56:34.534978",
  "updated_at": "2020-03-27T12:56:34.534978",
  "user": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "name": "John Doe"
  },
  "account": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "platform_username": "[email protected]"
  },
  "work_platform": {
    "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
    "name": "Instagram",
    "logo_url": "https://insightiq.ai/storage/instagram.png"
  },
  "amount": 123.45,
  "currency": "USD",
  "status": "SCHEDULED",
  "payout_interval": "AUTOMATIC_DAILY",
  "bank_details": {
    "name": "string",
    "account_last_digits": "string",
    "account_routing_number": "string"
  },
  "external_id": "5790fbc3-b022-437b-abf8-0492c7a82056",
  "payout_at": "2020-03-27T12:56:34.534978",
  "platform_profile_id": "UCEyLTzBtHJhlUwkeWhxfMXw",
  "platform_profile_name": "Peter Parker"
}

Returns payout object.

Path parameters

· 1

id string required

Unique identifier for the payout

Path parameters

Responses