Distributions represent how funds from an order are split across Merchants and Channels. These APIs allow you to programmatically retrieve and search distributions tied to orders, enabling clear financial visibility and auditability.

Violet exposes the following APIs for access to Distributions data:

Each of these APIs provides a different way to access the data you need. The Get Distributions API allows you to retrieve all distributions for you or a specific merchant you are connected to, while the Search Distributions API enables you to filter and search for distributions based on various criteria. You can learn more about each API by clicking on the links above.

​
Understanding the Distribution Object

The Distribution object represents the calculated split of funds from an order, including amounts for merchants, channels, Violet, and any associated adjustments like tax, shipping, or commissions.

Each distribution record contains critical financial and metadata fields that allow you to trace, audit, and reconcile payments through Violet.

​
Fields

FieldTypeDescription
idintegerUnique identifier for the distribution record.
typestringType of distribution: PAYMENT or REFUND.
payout_account_idintegerID of the Violet Payout Account the distribution is tied to.
payout_account_typestringEntity type: MERCHANT or DEVELOPER.
currencystringISO 4217 currency code (e.g., USD, EUR).
distribution_amountintegerOriginal amount before deductions, in minor units (e.g., cents).
net_distribution_amountintegerFinal amount after all deductions (fees, commissions, discounts).
tax_amountintegerPortion of the distribution that covers tax charges.
shipping_amountintegerPortion of the distribution that covers shipping charges.
commissionintegerCommission amount earned by the channel.
payment_provider_total_feeintegerTotal fee charged by the payment provider for the transaction.
payment_provider_volume_feeintegerVolume-based fee charged by the payment provider.
payment_provider_fixed_feeintegerFixed fee charged by the payment provider.
app_idintegerID of the Violet App associated with the transaction.
app_namestringName of the Violet App.
merchant_idintegerID of the merchant involved in the transaction.
merchant_namestringMerchant’s name.
merchant_commission_ratedoubleCommission rate applied to the merchant.
payment_provider_transaction_idstringPayment provider’s transaction ID (e.g., Stripe Charge ID).
payment_providerstringPayment service that processed the transaction (e.g., STRIPE).
statusstringStatus of the distribution: PENDING, SENT, REVERSED, FAILED.
bag_idlongID of the Bag (checkout/cart) associated with the distribution.
bag_sub_totalintegerPre-discount and pre-tax total for the bag.
bag_commissionable_amountintegerAmount eligible for commission after adjustments.
bag_shipping_totalintegerTotal shipping charges for the bag.
bag_tax_totalintegerTotal taxes applied to the bag.
bag_discount_totalintegerDiscounts applied to the bag.
bag_totalintegerFinal bag total after shipping, taxes, and discounts.
external_order_idstringExternal ecommerce platform order ID (e.g., Shopify Order ID).
order_idlongViolet internal order ID.
order_totalintegerTotal value of the Violet Order.
payout_idintegerID of the payout batch this distribution was included in.
payout_amountlongAmount of the payout batch.
date_payout_createddatetimeTimestamp when the payout was created.
date_payout_settleddatetimeTimestamp when the payout settled in the bank account.
payout_transfer_idlongID of the transfer associated with this distribution.
refund_idlongRefund ID if the distribution is related to a refund.
refund_discrepancyintegerDiscrepancy amount, if any, due to refund errors.
tax_remitterstringWho is responsible for tax remittance: APP or MERCHANT.
date_createddatetimeTimestamp of when the distribution record was created.
date_last_modifieddatetimeTimestamp of the last modification to the record.