Get Transfer Group for Bag

Get transfer group for a bag

get

Path parameters

order_idinteger · int64Required

bag_idinteger · int64Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

Transfer group for bag

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

get

/orders/{order_id}/bags/{bag_id}/transfer_group

HTTPcURLJavaScriptPython

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

200

Transfer group for bag

{
  "bag_id": 1,
  "merchant_id": 1,
  "is_complete": true,
  "transfers": [
    {
      "id": 1,
      "payment_transaction": 1,
      "payout_id": 1,
      "payment_provider_id": "text",
      "payment_provider_payout_id": "text",
      "payout_account_id": 1,
      "bag_amount": 1,
      "bag_currency": "text",
      "amount": 1,
      "currency": "text",
      "status": "SENT",
      "type": "MERCHANT",
      "payment_provider": "STRIPE",
      "related_orders": [
        "text"
      ],
      "related_bags": [
        "text"
      ],
      "related_distributions": [
        "text"
      ],
      "transfer_reversals": [
        "text"
      ],
      "idempotency_key": "text",
      "transfer_mechanism": "STANDARD_TRANSFERS",
      "date_created": "2026-02-20T21:05:11.512Z",
      "date_last_modified": "2026-02-20T21:05:11.512Z",
      "errors": [
        {
          "id": 1,
          "error_code": 1,
          "error_message": "text",
          "resolved": true,
          "date_resolved": "2026-02-20T21:05:11.512Z",
          "date_created": "2026-02-20T21:05:11.512Z",
          "payout_transfer_id": 1
        }
      ],
      "payoutExternalId": "text",
      "paymentService": "STRIPE",
      "externalId": "text"
    }
  ]
}