Process Transfers for Bags

This endpoint only accepts bag_ids in the request body. Passing in any other fields will result in an exception.

Process Transfers for Bags

post

Initiates payout transfers for multiple bags in a single batch request. The request body must contain a list of bag IDs to process. Transfers are sent to the merchant's configured payout account via the appropriate payment provider. The response separates results into successful and failed transfers. Dashboard and admin users must specify a target app_id query parameter; channel users can only process transfers for their own application.

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

Body

application/json

Request to process pending transfers for a given list of Order or Bag identifiers

application_idinteger · int32Optional

Identifier of the app that this request is being made for.

developer_idinteger · int32Optional

Identifier of the channel making this request.

order_idsinteger · int64[]Optional

List of Violet Order identifiers for which to process pending transfers.

bag_idsinteger · int64[]Optional

List of Violet Bag identifiers for which to process pending transfers.

Responses

200

ok

application/json

Summary of process transfers request, split by successful and failed transfers.

400

bad request

application/json

403

forbidden

application/json

500

internal server error

application/json

post

/orders/bags/transfer_funds

HTTPcURLJavaScriptPython

POST /v1/orders/bags/transfer_funds HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "bag_ids": [
    139973,
    139974
  ]
}

{
  "successful_transfers": {
    "count": 1,
    "bag_ids": [
      139974,
      139973
    ],
    "transfers": [
      {
        "id": 93647,
        "payment_provider_id": "tr_1QNNtlKUtPkD6xdU9uFqXVa0",
        "payout_account_id": 1025,
        "amount": 360000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "STRIPE",
        "related_orders": [
          "149486",
          "149487"
        ],
        "related_bags": [
          "139973",
          "139974"
        ],
        "related_distributions": [
          "89092",
          "89090"
        ],
        "date_created": "2024-11-21T00:05:29+0000",
        "date_last_modified": "2024-11-21T00:05:29+0000",
        "errors": [],
        "payment_service": "STRIPE",
        "external_id": "tr_1QNNtlKUtPkD6xdU9uFqXVa0"
      }
    ]
  },
  "failed_transfers": {
    "count": 0,
    "bag_ids": [],
    "transfers": []
  }
}