Get Transfer

Get Payout Transfer

get

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

Record of Payout Transfer

idinteger · int64Read-onlyOptional

payment_transactioninteger · int64Optional

Unique identifier of the Payment Transaction that this Transfer is associated with.

payout_idinteger · int32Optional

ID of the Payout, if any, this Transfer is associated to

payment_provider_idstringOptional

ID of the transfer record in Stripe

payment_provider_payout_idstringOptional

External ID of the payout record

payout_account_idinteger · int32Optional

ID of the Payout Account this Transfer belongs to.

bag_amountinteger · int32Optional

Total value for the bag associated to this transfer

bag_currencystringOptional

Original currency that this bag was processed in.

amountinteger · int32Optional

Total amount in fractional currency unit (e.g. cents) for this transfer.

currencystringOptional

Currency that this transfer was processed in.

statusstring · enumOptional

Status of the transfer.

Possible values:

typestring · enumOptional

Account type of the Transfer recipient.

Possible values:

payment_providerstring · enumOptional

Payment Provider that this transfer is executed with. This is the provider that handles transfer processing for this payout account.

Possible values:

related_ordersstring[]Optional

Identifiers of the Orders in Violet that are associated with this transfer.

related_bagsstring[]Optional

Identifiers of the Bags in Violet that are associated with this transfer.

related_distributionsstring[]Optional

Identifiers of the Distributions in Violet that are associated with this transfer. The amount of this Transfer is directly computed as the sum of all Distributions related to it.

transfer_reversalsstring[]Optional

Unique identifiers of the Transfer Reversal objects in Violet that are associated with this transfer.

idempotency_keystringOptional

Unique key to prevent duplicate transfers. This is generated by the Violet and unique for each transfer being processed.

transfer_mechanismstring · enumOptional

Mechanism used to execute this transfer. STANDARD_TRANSFERS uses /v1/transfers API, DESTINATION_PAYMENTS uses Payment Intent with transfer_data.destination. This is stored at creation time to prevent configuration race conditions.

Possible values:

date_createdstring · date-timeOptional

Time at which the object was created. In ISO-8601 format.

date_last_modifiedstring · date-timeOptional

Time at which the object was last modified. In ISO-8601 format.

externalIdstringOptional

payoutExternalIdstringOptional

paymentServicestring · enumOptionalPossible values:

get

/payments/transfers/{transfer_id}

HTTPcURLJavaScriptPython

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",
  "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": "2026-02-20T18:28:14.405Z",
  "date_last_modified": "2026-02-20T18:28:14.405Z",
  "errors": [
    {
      "id": 1,
      "error_code": 1,
      "error_message": "text",
      "resolved": true,
      "date_resolved": "2026-02-20T18:28:14.405Z",
      "date_created": "2026-02-20T18:28:14.405Z",
      "payout_transfer_id": 1
    }
  ],
  "externalId": "text",
  "payoutExternalId": "text",
  "paymentService": "STRIPE"
}