Retrieve e-commerce balances in bulk

Search balances in bulk by providing the IDs.

This is best used in combination with webhooks - you can directly take the IDs from "BALANCES.ADDED" and "BALANCES.UPDATED" webhook notifications and pass on to this API to get the updated transaction items.

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".

POST /v1/commerce/income/balances/search

Basic auth

curl 'https://api.sandbox.insightiq.ai/v1/commerce/income/balances/search' \
  --request POST \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'

{
  "data": [
    {
      "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"
      },
      "balance": [
        {
          "amount": 123.45,
          "currency": "USD"
        }
      ],
      "balance_at": "2020-03-27T00:00:00.000000",
      "platform_profile_id": "UCEyLTzBtHJhlUwkeWhxfMXw",
      "platform_profile_name": "Peter Parker"
    }
  ]
}

Returns all balance objects matching the IDs.

Body

· CommerceBalanceSearch

application/json

ids array of string · min items: 1· max items: 100 required

List of upto 100 commerce balance IDs for which to fetch data

Body

Responses