POST
/
orders
/
transfer_funds
curl --request POST \
  --url https://sandbox-api.violet.io/v1/orders/transfer_funds \
  --header 'Content-Type: application/json' \
  --header 'X-Violet-App-Id: <x-violet-app-id>' \
  --header 'X-Violet-App-Secret: <x-violet-app-secret>' \
  --header 'X-Violet-Token: <x-violet-token>' \
  --data '{
  "order_ids": [
    149483,
    149484
  ]
}'
{
  "successful_transfers": {
    "count": 1,
    "order_count": 2,
    "order_ids": [
      149483,
      149484
    ],
    "bag_ids": [
      139970,
      139971
    ],
    "transfers": [
      {
        "id": 93645,
        "payment_provider_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH",
        "payout_account_id": 1025,
        "amount": 360000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "STRIPE",
        "related_orders": [
          "149483",
          "149484"
        ],
        "related_bags": [
          "139971",
          "139970"
        ],
        "related_distributions": [
          "89086",
          "89084"
        ],
        "date_created": "2024-11-21T00:03:45+0000",
        "date_last_modified": "2024-11-21T00:03:45+0000",
        "errors": [],
        "payment_service": "STRIPE",
        "external_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH"
      }
    ]
  },
  "failed_transfers": {
    "count": 0,
    "order_count": 0,
    "order_ids": [],
    "bag_ids": [],
    "transfers": []
  }
}

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

Headers

​
X-Violet-Token
string
required
​
X-Violet-App-Secret
string
required
​
X-Violet-App-Id
integer
required

Body

application/json

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

Response

200 - application/json

Process Transfers for multiple Orders

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