Process Transfers for a single Bag

As of October 8th 2025: Duplicate transfer requests now return a 409 Conflict error instead of a 2XX response with an empty result.

When attempting to process transfers for bags that have already had their distributions settled, the API returns the following error:

{
  "error": "transfer_already_processed",
  "error_code": "4461",
  "error_message": "All transfers for this entity have already been processed."
}

Process Transfers for a single Bag

post

Initiates a payout transfer for a specific bag within an order. The order is validated for existence and the caller's access is verified before processing. Returns a single PayoutTransfer object representing the transfer result for the specified bag, including the transfer status, amount, payment provider details, and any errors encountered.

Path parameters

order_idinteger · int64Required

ID of the order containing the bag

Example: 11111

bag_idinteger · int64Required

ID of the bag to process the transfer for

Example: 22222

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

post

/orders/{order_id}/bags/{bag_id}/transfer_funds

HTTPcURLJavaScriptPython

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

{
  "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"
}