Get Transfer by Payment Provider Transfer ID

Get Transfer by External Id

get

Path parameters

external_transfer_idstringRequired

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

default

default response

application/json

get

/payments/transfers/external/{external_transfer_id}

HTTPcURLJavaScriptPython

GET /v1/payments/transfers/external/{external_transfer_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

default

default response

{
  "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",
  "idempotency_key": "text",
  "transfer_mechanism": "STANDARD_TRANSFERS",
  "date_created": "2026-03-13T19:29:44.414Z",
  "date_last_modified": "2026-03-13T19:29:44.414Z",
  "errors": [
    {
      "id": 1,
      "error_code": 1,
      "error_message": "text",
      "resolved": true,
      "date_resolved": "2026-03-13T19:29:44.414Z",
      "date_created": "2026-03-13T19:29:44.414Z",
      "payout_transfer_id": 1
    }
  ],
  "externalId": "text",
  "payoutExternalId": "text",
  "paymentService": "STRIPE",
  "effectiveRelatedOrderIds": [
    1
  ],
  "effectiveRelatedBagIds": [
    1
  ],
  "effectiveRelatedDistributionIds": [
    1
  ],
  "effectiveTransferReversalIds": [
    1
  ],
  "related_order_ids": [
    1
  ],
  "related_bag_ids": [
    1
  ],
  "related_distribution_ids": [
    1
  ],
  "transfer_reversal_ids": [
    1
  ]
}