Process Transfers for Orders
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
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
Process Transfers for multiple Orders
application/json
post
POST /v1/orders/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: 29
{
"order_ids": [
149483,
149484
]
}
200
Process Transfers for multiple Orders
{
"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": []
}
}
Last updated
Was this helpful?