Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Process Transfers for Bags
Request to process pending transfers for a given list of Order or Bag identifiers
Identifier of the app that this request is being made for.
Identifier of the channel making this request.
List of Violet Order identifiers for which to process pending transfers.
List of Violet Bag identifiers for which to process pending transfers.
This endpoint only accepts bag_ids in the request body. Passing in any other fields will result in an exception.
Body
Request to process pending transfers for a given list of Order or Bag identifiers
Identifier of the app that this request is being made for.
Identifier of the channel making this request.
List of Violet Order identifiers for which to process pending transfers.
List of Violet Bag identifiers for which to process pending transfers.
Response
Summary of process transfers request, split by successful and failed transfers.
Summary of job to process transfers for a list of given order or bag identifiers.
Count of transfers for which details are present in the transfers list.
Count of orders that this transfer summary record is associated with.
List of Violet Order identifiers for which transfers were processed. Details of each transfer are included in the transfers list.
List of Violet Bag identifiers for which transfers were processed. Details of each transfer are included in the transfers list.
List of Transfer details for each transfer that was processed as a part of the job that this transfer summary is associated with.
ID of the Payout, if any, this Transfer is associated to
ID of the transfer record in Stripe
External ID of the payout record
ID of the Payout Account this Transfer belongs to.
Total value for the bag associated to this transfer
Original currency that this bag was processed in.
Total amount in fractional currency unit (e.g. cents) for this transfer.
Currency that this transfer was processed in.
Status of the transfer.
SENT, REVERSED, PARTIALLY_REVERSED, PENDING, FAILED, BYPASSED Payment Provider that this transfer is executed with. This is the provider that handles transfer processing for this payout account.
STRIPE, NUVEI, CREDOVA, EXTERNAL Identifiers of the Orders in Violet that are associated with this transfer.
Identifiers of the Bags in Violet that are associated with this transfer.
Identifiers of the Distributions in Violet that are associated with this transfer. The amount of this Transfer is directly computed as the sum of all Distributions related to it.
Time at which the object was created. In ISO-8601 format.
Time at which the object was last modified. In ISO-8601 format.
List of errors associated to this payout transfer during processing.. This value will only be populated if there are errors during processing
Unique identifier for the object.
Unique error code corresponding to this error.
Error message describing the issue in the underlying system.
ID of the Payout Transfer this Error is associated to
STRIPE, NUVEI, CREDOVA, EXTERNAL Summary of job to process transfers for a list of given order or bag identifiers.
Count of transfers for which details are present in the transfers list.
Count of orders that this transfer summary record is associated with.
List of Violet Order identifiers for which transfers were processed. Details of each transfer are included in the transfers list.
List of Violet Bag identifiers for which transfers were processed. Details of each transfer are included in the transfers list.
List of Transfer details for each transfer that was processed as a part of the job that this transfer summary is associated with.
ID of the Payout, if any, this Transfer is associated to
ID of the transfer record in Stripe
External ID of the payout record
ID of the Payout Account this Transfer belongs to.
Total value for the bag associated to this transfer
Original currency that this bag was processed in.
Total amount in fractional currency unit (e.g. cents) for this transfer.
Currency that this transfer was processed in.
Status of the transfer.
SENT, REVERSED, PARTIALLY_REVERSED, PENDING, FAILED, BYPASSED Payment Provider that this transfer is executed with. This is the provider that handles transfer processing for this payout account.
STRIPE, NUVEI, CREDOVA, EXTERNAL Identifiers of the Orders in Violet that are associated with this transfer.
Identifiers of the Bags in Violet that are associated with this transfer.
Identifiers of the Distributions in Violet that are associated with this transfer. The amount of this Transfer is directly computed as the sum of all Distributions related to it.
Time at which the object was created. In ISO-8601 format.
Time at which the object was last modified. In ISO-8601 format.
List of errors associated to this payout transfer during processing.. This value will only be populated if there are errors during processing
Unique identifier for the object.
Unique error code corresponding to this error.
Error message describing the issue in the underlying system.
ID of the Payout Transfer this Error is associated to
STRIPE, NUVEI, CREDOVA, EXTERNAL Was this page helpful?