Search Distributions

Search Distributions

post

Path parameters

account_typestringRequired

account_idinteger · int32Required

Query parameters

include_merchantsbooleanOptionalDefault: true

include_channelsbooleanOptionalDefault: true

sizeinteger · int32OptionalDefault: 20

pageinteger · int32OptionalDefault: 1

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

Search Request for Distributions.

bag_idinteger · int64Optional

ID of the bag associated to this Distribution.

order_idinteger · int64Optional

ID of the order associated to this Distribution.

external_order_idstringOptional

ID of the order on the external ecommerce platform.

merchant_idinteger · int32Optional

ID of the merchant associated to this Distribution.

payout_idinteger · int32Optional

ID of the payout associated to this Distribution.

payout_transfer_idinteger · int64Optional

ID of the payout transfer associated to this Distribution.

before_datestring · date-timeOptional

Before date

after_datestring · date-timeOptional

After date

Responses

default

default response

application/json

post

/payments/{account_type}/{account_id}/distributions/search

HTTPcURLJavaScriptPython

POST /v1/payments/{account_type}/{account_id}/distributions/search 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: 186

{
  "bag_id": 1,
  "order_id": 1,
  "external_order_id": "text",
  "merchant_id": 1,
  "payout_id": 1,
  "payout_transfer_id": 1,
  "before_date": "2025-12-23T10:37:45.861Z",
  "after_date": "2025-12-23T10:37:45.861Z"
}

default

default response

{
  "totalPages": 1,
  "totalElements": 1,
  "size": 1,
  "content": [
    {
      "id": 1,
      "type": "PAYMENT",
      "payout_account_id": 1,
      "payout_account_type": "MERCHANT",
      "currency": "text",
      "amount": 1,
      "net_distribution_amount": 1,
      "distribution_amount": 1,
      "tax_amount": 1,
      "shipping_amount": 1,
      "commission": 1,
      "payment_provider_total_fee": 1,
      "payment_provider_volume_fee": 1,
      "payment_provider_fixed_fee": 1,
      "app_id": 1,
      "app_name": "text",
      "merchant_id": 1,
      "merchant_name": "text",
      "merchant_commission_rate": 1,
      "payment_provider_transaction_id": "text",
      "payment_provider": "STRIPE",
      "status": "SENT",
      "bag_id": 1,
      "bag_sub_total": 1,
      "bag_commissionable_amount": 1,
      "bag_shipping_total": 1,
      "bag_tax_total": 1,
      "bag_discount_total": 1,
      "bag_total": 1,
      "gross_subtotal": 1,
      "gross_total": 1,
      "totals_include_commission": true,
      "external_order_id": "text",
      "order_id": 1,
      "order_total": 1,
      "payout_id": 1,
      "payout_amount": 1,
      "payout_date": "2025-12-23T10:37:45.861Z",
      "date_payout_created": "2025-12-23T10:37:45.861Z",
      "date_payout_settled": "2025-12-23T10:37:45.861Z",
      "payout_transfer_id": 1,
      "refund_id": 1,
      "adjustment_id": 1,
      "refund_discrepancy": 1,
      "idempotency_key": "text",
      "tax_remitter": "APP",
      "date_created": "2025-12-23T10:37:45.861Z",
      "date_last_modified": "2025-12-23T10:37:45.861Z",
      "paymentService": "STRIPE",
      "paymentServiceTotalFee": 1,
      "paymentServiceVolumeFee": 1,
      "paymentServiceFixedFee": 1,
      "externalTransactionId": "text"
    }
  ],
  "number": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "first": true,
  "pageable": {
    "offset": 1,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1
  },
  "numberOfElements": 1,
  "last": true,
  "empty": true
}