Transfers
Process Transfers for Bags
POST
/
orders
/
bags
/
transfer_funds
This endpoint only accepts bag_ids
in the request body. Passing in any other fields will result in an exception.
Headers
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
Body
application/json
Request to process pending transfers for a given list of Order or Bag identifiers
application_id
integer
Identifier of the app that this request is being made for.
developer_id
integer
Identifier of the channel making this request.
order_ids
integer[]
List of Violet Order identifiers for which to process pending transfers.
bag_ids
integer[]
List of Violet Bag identifiers for which to process pending transfers.
Response
200 - application/json
Summary of process transfers request, split by successful and failed transfers.
successful_transfers
object
Summary of job to process transfers for a list of given order or bag identifiers.
failed_transfers
object
Summary of job to process transfers for a list of given order or bag identifiers.
Was this page helpful?