Get Bag Transfer Groups

Get Bag Transfer Groups

get

Retrieves transfer groups for all bags, optionally filtered by completion status. When is_complete is false, returns bags with FAILED transfers. When is_complete is true, returns bags with SENT transfers. When is_complete is omitted, returns all bags with any transfers. Dashboard and admin users must specify a target app_id query parameter; channel users can only access transfer groups for their own application. Each bag transfer group contains the bag ID, merchant ID, and the list of payout transfers.

Query parameters

is_completebooleanOptional

Filter by transfer completion status. When false, returns bags with FAILED transfers. When true, returns bags with SENT transfers. Omit to return all bags with transfers.

Example: false

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Responses

200

ok

application/json

All transfer attempts for a single bag and merchant combination

bag_idinteger · int64Optional

ID of the bag these transfers are associated with

merchant_idinteger · int32Optional

ID of the merchant receiving funds in these transfers

is_completebooleanOptional

Whether all transfers for this bag have been successfully sent

403

forbidden

application/json

500

internal server error

application/json

get/orders/bags/transfer_groups

GET /v1/orders/bags/transfer_groups HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

[
  {
    "bag_id": 139861,
    "merchant_id": 10000,
    "transfers": [
      {
        "id": 93557,
        "payment_provider_id": "tr_1QNJxRKUtPkD6xdUyTAqNfEw",
        "payout_account_id": 1025,
        "amount": 180000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "EXTERNAL",
        "related_orders": [
          "149393"
        ],
        "related_bags": [
          "139861"
        ],
        "date_created": "2024-11-20T19:53:01+0000",
        "date_last_modified": "2024-11-20T19:53:01+0000",
        "errors": [],
        "payment_service": "EXTERNAL",
        "external_id": "tr_1QNJxRKUtPkD6xdUyTAqNfEw"
      }
    ]
  },
  {
    "bag_id": 139862,
    "merchant_id": 10000,
    "transfers": [
      {
        "id": 93558,
        "payment_provider_id": "tr_1QNJyxKUtPkD6xdUIfdcyt8I",
        "payout_account_id": 1025,
        "amount": 180000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "EXTERNAL",
        "related_orders": [
          "149394"
        ],
        "related_bags": [
          "139862"
        ],
        "date_created": "2024-11-20T19:54:35+0000",
        "date_last_modified": "2024-11-20T19:54:35+0000",
        "errors": [],
        "payment_service": "EXTERNAL",
        "external_id": "tr_1QNJyxKUtPkD6xdUIfdcyt8I"
      }
    ]
  }
]