Get Transfer
Path parameters
transfer_idinteger · int64Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
default
default response
application/json
get
GET /v1/payments/transfers/{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",
"payment_provider": "STRIPE",
"related_orders": [
"text"
],
"related_bags": [
"text"
],
"related_distributions": [
"text"
],
"transfer_reversals": [
"text"
],
"idempotency_key": "text",
"date_created": "2025-07-10T07:09:50.065Z",
"date_last_modified": "2025-07-10T07:09:50.065Z",
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-10T07:09:50.065Z",
"date_created": "2025-07-10T07:09:50.065Z",
"payout_transfer_id": 1
}
],
"payoutExternalId": "text",
"paymentService": "STRIPE",
"externalId": "text"
}
Last updated
Was this helpful?