Get Transfer Group for Order

Get Transfer Group for Order

get

Retrieves the transfer group for a specific order. The transfer group contains all payout transfers organized by bag and merchant. Each bag transfer group includes the bag ID, merchant ID, and the list of PayoutTransfer objects associated with that bag-merchant combination. The order is validated for existence and caller access before retrieval.

Path parameters

order_idinteger · int64Required

ID of the order to retrieve the transfer group for

Example: 11111

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

403

forbidden

application/json

404

not found

application/json

500

internal server error

application/json

get

/orders/{order_id}/transfer_group

HTTPcURLJavaScriptPython

GET /v1/orders/{order_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: */*

{
  "order_id": 149393,
  "bag_transfer_groups": [
    {
      "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"
        }
      ]
    }
  ]
}