Distributions
Get Distributions
Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Onboarding
- 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
Payments
- Payout Accounts
- Distributions
- Transfers
Events
- Webhooks
- Webhook Events
- Webhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Distributions
Get Distributions
GET
/
payments
/
{account_type}
/
{account_id}
/
distributions
curl --request GET \
--url https://sandbox-api.violet.io/v1/payments/{account_type}/{account_id}/distributions
{
"totalPages": 123,
"totalElements": 123,
"first": true,
"size": 123,
"content": [
{
"id": 123,
"type": "PAYMENT",
"payout_account_id": 123,
"payout_account_type": "MERCHANT",
"currency": "<string>",
"amount": 123,
"net_distribution_amount": 123,
"distribution_amount": 123,
"tax_amount": 123,
"shipping_amount": 123,
"commission": 123,
"payment_provider_total_fee": 123,
"payment_provider_volume_fee": 123,
"payment_provider_fixed_fee": 123,
"app_id": 123,
"app_name": "<string>",
"merchant_id": 123,
"merchant_name": "<string>",
"merchant_commission_rate": 123,
"payment_provider_transaction_id": "<string>",
"payment_provider": "STRIPE",
"status": "SENT",
"bag_id": 123,
"bag_sub_total": 123,
"bag_commissionable_amount": 123,
"bag_shipping_total": 123,
"bag_tax_total": 123,
"bag_discount_total": 123,
"bag_total": 123,
"external_order_id": "<string>",
"order_id": 123,
"order_total": 123,
"payout_id": 123,
"payout_amount": 123,
"payout_date": "2023-11-07T05:31:56Z",
"date_payout_created": "2023-11-07T05:31:56Z",
"date_payout_settled": "2023-11-07T05:31:56Z",
"payout_transfer_id": 123,
"refund_id": 123,
"refund_discrepancy": 123,
"tax_remitter": "APP",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"paymentService": "STRIPE",
"paymentServiceTotalFee": 123,
"paymentServiceVolumeFee": 123,
"paymentServiceFixedFee": 123,
"externalTransactionId": "<string>"
}
],
"number": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}
Query Parameters
Response
default - application/json
default response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/payments/{account_type}/{account_id}/distributions
{
"totalPages": 123,
"totalElements": 123,
"first": true,
"size": 123,
"content": [
{
"id": 123,
"type": "PAYMENT",
"payout_account_id": 123,
"payout_account_type": "MERCHANT",
"currency": "<string>",
"amount": 123,
"net_distribution_amount": 123,
"distribution_amount": 123,
"tax_amount": 123,
"shipping_amount": 123,
"commission": 123,
"payment_provider_total_fee": 123,
"payment_provider_volume_fee": 123,
"payment_provider_fixed_fee": 123,
"app_id": 123,
"app_name": "<string>",
"merchant_id": 123,
"merchant_name": "<string>",
"merchant_commission_rate": 123,
"payment_provider_transaction_id": "<string>",
"payment_provider": "STRIPE",
"status": "SENT",
"bag_id": 123,
"bag_sub_total": 123,
"bag_commissionable_amount": 123,
"bag_shipping_total": 123,
"bag_tax_total": 123,
"bag_discount_total": 123,
"bag_total": 123,
"external_order_id": "<string>",
"order_id": 123,
"order_total": 123,
"payout_id": 123,
"payout_amount": 123,
"payout_date": "2023-11-07T05:31:56Z",
"date_payout_created": "2023-11-07T05:31:56Z",
"date_payout_settled": "2023-11-07T05:31:56Z",
"payout_transfer_id": 123,
"refund_id": 123,
"refund_discrepancy": 123,
"tax_remitter": "APP",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"paymentService": "STRIPE",
"paymentServiceTotalFee": 123,
"paymentServiceVolumeFee": 123,
"paymentServiceFixedFee": 123,
"externalTransactionId": "<string>"
}
],
"number": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}