Search Transfers

Search Transfers

post

Query parameters

sizeinteger · int32OptionalDefault: 20

pageinteger · int32OptionalDefault: 1

app_idinteger · int32Optional

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

Parameters used to filter and retrieve payout transfers based on criteria such as order, merchant, status, and creation date.

order_idinteger · int64Optional

Filter transfers associated with a specific order.

bag_idinteger · int64Optional

Filter transfers associated with a specific bag.

transfer_idsinteger · int64[]Optional

Filter transfers based on a collection of transferIds.

order_idsinteger · int64[]Optional

Filter transfers associated with multiple orders.

bag_idsinteger · int64[]Optional

Filter transfers associated with multiple bags.

merchant_idinteger · int32Optional

Filter transfers related to a specific merchant.

payout_account_idinteger · int32Optional

Filter transfers directed to a specific payout account.

payout_idinteger · int64Optional

Filter transfers associated with a specific payout.

paypro_transfer_idinteger · int32Optional

Filter transfers with a sepcific payment provider transfer Id.

statusstring · enumOptional

Filter transfers based on their current status.

Possible values:

created_afterstring · date-timeOptional

Return transfers created on or after this timestamp (inclusive).

created_beforestring · date-timeOptional

Return transfers created before this timestamp (exclusive).

Responses

default

default response

application/json

post

/payments/transfers

HTTPcURLJavaScriptPython

POST /v1/payments/transfers 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: 252

{
  "order_id": 1,
  "bag_id": 1,
  "transfer_ids": [
    1
  ],
  "order_ids": [
    1
  ],
  "bag_ids": [
    1
  ],
  "merchant_id": 1,
  "payout_account_id": 1,
  "payout_id": 1,
  "paypro_transfer_id": 1,
  "status": "SENT",
  "created_after": "2025-12-23T16:00:26.433Z",
  "created_before": "2025-12-23T16:00:26.433Z"
}

default

default response

{
  "totalPages": 1,
  "totalElements": 1,
  "size": 1,
  "content": [
    {
      "id": 1,
      "payment_transaction": 1,
      "payout_id": 1,
      "payment_provider_id": "text",
      "payment_provider_payout_id": "text",
      "payout_account_id": 1,
      "bag_amount": 1,
      "bag_currency": "text",
      "amount": 1,
      "currency": "text",
      "status": "SENT",
      "type": "MERCHANT",
      "payment_provider": "STRIPE",
      "related_orders": [
        "text"
      ],
      "related_bags": [
        "text"
      ],
      "related_distributions": [
        "text"
      ],
      "transfer_reversals": [
        "text"
      ],
      "idempotency_key": "text",
      "transfer_mechanism": "STANDARD_TRANSFERS",
      "date_created": "2025-12-23T16:00:26.433Z",
      "date_last_modified": "2025-12-23T16:00:26.433Z",
      "errors": [
        {
          "id": 1,
          "error_code": 1,
          "error_message": "text",
          "resolved": true,
          "date_resolved": "2025-12-23T16:00:26.433Z",
          "date_created": "2025-12-23T16:00:26.433Z",
          "payout_transfer_id": 1
        }
      ],
      "externalId": "text",
      "payoutExternalId": "text",
      "paymentService": "STRIPE"
    }
  ],
  "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
}