Get Order Transfer Groups

Get Order Transfer Groups

get

Retrieves transfer groups for all orders, optionally filtered by completion status. When is_complete is false, returns orders with FAILED transfers. When is_complete is true, returns orders with SENT transfers. When is_complete is omitted, returns all orders 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 order transfer group contains the order ID and nested bag transfer groups organized by bag and merchant.

Query parameters

is_completebooleanOptional

Filter by transfer completion status. When false, returns orders with FAILED transfers. When true, returns orders with SENT transfers. Omit to return all orders 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

Complete set of money movement attempts for a single order, organized by merchant and bag

order_idinteger · int64Optional

ID of the order these transfers are associated with

is_completebooleanOptional

Whether all expected transfers for this order have been successfully sent

date_createdstring · date-timeOptional

Time at which the earliest transfer in this group was created. In ISO-8601 format

date_last_modifiedstring · date-timeOptional

Time at which the latest transfer in this group was last modified. In ISO-8601 format

403

forbidden

application/json

500

internal server error

application/json

get

/orders/transfer_groups

HTTPcURLJavaScriptPython

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

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