POST
/
orders
/
{order_id}
/
bags
/
{bag_id}
/
transfer_funds

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

order_id
integer
required
bag_id
integer
required

Response

200 - application/json

Record of Payout Transfer

id
integer
payout_id
integer

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

payment_provider_id
string

ID of the transfer record in Stripe

payment_provider_payout_id
string

External ID of the payout record

payout_account_id
integer

ID of the Payout Account this Transfer belongs to.

bag_amount
integer

Total value for the bag associated to this transfer

bag_currency
string

Original currency that this bag was processed in.

amount
integer

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

currency
string

Currency that this transfer was processed in.

status
enum<string>

Status of the transfer.

Available options:
SENT,
REVERSED,
PARTIALLY_REVERSED,
PENDING,
FAILED,
BYPASSED
payment_provider
enum<string>

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

Available options:
STRIPE,
NUVEI,
CREDOVA,
EXTERNAL
related_orders
string[]

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

related_bags
string[]

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

related_distributions
string[]

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.

date_created
string

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

date_last_modified
string

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

errors
object[]

List of errors associated to this payout transfer during processing.. This value will only be populated if there are errors during processing

externalId
string
payoutExternalId
string
paymentService
enum<string>
Available options:
STRIPE,
NUVEI,
CREDOVA,
EXTERNAL