Process Transfers for Orders - Violet Documentation

POST

orders

transfer_funds

{
  "successful_transfers": {
    "count": 1,
    "order_count": 2,
    "order_ids": [
      149483,
      149484
    ],
    "bag_ids": [
      139970,
      139971
    ],
    "transfers": [
      {
        "id": 93645,
        "payment_provider_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH",
        "payout_account_id": 1025,
        "amount": 360000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "STRIPE",
        "related_orders": [
          "149483",
          "149484"
        ],
        "related_bags": [
          "139971",
          "139970"
        ],
        "related_distributions": [
          "89086",
          "89084"
        ],
        "date_created": "2024-11-21T00:03:45+0000",
        "date_last_modified": "2024-11-21T00:03:45+0000",
        "errors": [],
        "payment_service": "STRIPE",
        "external_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH"
      }
    ]
  },
  "failed_transfers": {
    "count": 0,
    "order_count": 0,
    "order_ids": [],
    "bag_ids": [],
    "transfers": []
  }
}

This endpoint only accepts order_ids in the request body. Passing in any other fields will result in an exception.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Body

application/json

Request to process pending transfers for a given list of Order or Bag identifiers

application_id

integer

Identifier of the app that this request is being made for.

bag_ids

integer[]

List of Violet Bag identifiers for which to process pending transfers.

developer_id

integer

Identifier of the channel making this request.

order_ids

integer[]

List of Violet Order identifiers for which to process pending transfers.

Response

200 - application/json

Summary of process transfers request, split by successful and failed transfers.

failed_transfers

object

Summary of job to process transfers for a list of given order or bag identifiers.

failed_transfers.bag_ids

integer[]

List of Violet Bag identifiers for which transfers were processed. Details of each transfer are included in the transfers list.

failed_transfers.count

integer

Count of transfers for which details are present in the transfers list.

failed_transfers.order_count

integer

Count of orders that this transfer summary record is associated with.

failed_transfers.order_ids

integer[]

List of Violet Order identifiers for which transfers were processed. Details of each transfer are included in the transfers list.

failed_transfers.transfers

object[]

List of Transfer details for each transfer that was processed as a part of the job that this transfer summary is associated with.

failed_transfers.transfers.amount

integer

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

failed_transfers.transfers.bag_amount

integer

Total value for the bag associated to this transfer

failed_transfers.transfers.bag_currency

string

Original currency that this bag was processed in.

failed_transfers.transfers.currency

string

Currency that this transfer was processed in.

failed_transfers.transfers.date_created

string

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

failed_transfers.transfers.date_last_modified

string

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

failed_transfers.transfers.errors

object[]

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

failed_transfers.transfers.externalId

string

failed_transfers.transfers.id

integer

failed_transfers.transfers.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

failed_transfers.transfers.payment_provider_id

string

ID of the transfer record in Stripe

failed_transfers.transfers.payment_provider_payout_id

string

External ID of the payout record

failed_transfers.transfers.paymentService

enum<string>

Available options:

STRIPE,

NUVEI,

CREDOVA,

EXTERNAL

failed_transfers.transfers.payout_account_id

integer

ID of the Payout Account this Transfer belongs to.

failed_transfers.transfers.payout_id

integer

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

failed_transfers.transfers.payoutExternalId

string

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

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.

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

failed_transfers.transfers.status

enum<string>

Status of the transfer.

Available options:

SENT,

REVERSED,

PARTIALLY_REVERSED,

PENDING,

FAILED,

BYPASSED

successful_transfers

object

Summary of job to process transfers for a list of given order or bag identifiers.

successful_transfers.bag_ids

integer[]

List of Violet Bag identifiers for which transfers were processed. Details of each transfer are included in the transfers list.

successful_transfers.count

integer

Count of transfers for which details are present in the transfers list.

successful_transfers.order_count

integer

Count of orders that this transfer summary record is associated with.

successful_transfers.order_ids

integer[]

List of Violet Order identifiers for which transfers were processed. Details of each transfer are included in the transfers list.

successful_transfers.transfers

object[]

List of Transfer details for each transfer that was processed as a part of the job that this transfer summary is associated with.

successful_transfers.transfers.amount

integer

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

successful_transfers.transfers.bag_amount

integer

Total value for the bag associated to this transfer

successful_transfers.transfers.bag_currency

string

Original currency that this bag was processed in.

successful_transfers.transfers.currency

string

Currency that this transfer was processed in.

successful_transfers.transfers.date_created

string

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

successful_transfers.transfers.date_last_modified

string

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

successful_transfers.transfers.errors

object[]

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

successful_transfers.transfers.externalId

string

successful_transfers.transfers.id

integer

successful_transfers.transfers.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

successful_transfers.transfers.payment_provider_id

string

ID of the transfer record in Stripe

successful_transfers.transfers.payment_provider_payout_id

string

External ID of the payout record

successful_transfers.transfers.paymentService

enum<string>

Available options:

STRIPE,

NUVEI,

CREDOVA,

EXTERNAL

successful_transfers.transfers.payout_account_id

integer

ID of the Payout Account this Transfer belongs to.

successful_transfers.transfers.payout_id

integer

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

successful_transfers.transfers.payoutExternalId

string

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

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.

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

successful_transfers.transfers.status

enum<string>

Status of the transfer.

Available options:

SENT,

REVERSED,

PARTIALLY_REVERSED,

PENDING,

FAILED,

BYPASSED

Was this page helpful?

{
  "successful_transfers": {
    "count": 1,
    "order_count": 2,
    "order_ids": [
      149483,
      149484
    ],
    "bag_ids": [
      139970,
      139971
    ],
    "transfers": [
      {
        "id": 93645,
        "payment_provider_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH",
        "payout_account_id": 1025,
        "amount": 360000,
        "currency": "USD",
        "status": "SENT",
        "payment_provider": "STRIPE",
        "related_orders": [
          "149483",
          "149484"
        ],
        "related_bags": [
          "139971",
          "139970"
        ],
        "related_distributions": [
          "89086",
          "89084"
        ],
        "date_created": "2024-11-21T00:03:45+0000",
        "date_last_modified": "2024-11-21T00:03:45+0000",
        "errors": [],
        "payment_service": "STRIPE",
        "external_id": "tr_1QNNs5KUtPkD6xdUHFhGa9HH"
      }
    ]
  },
  "failed_transfers": {
    "count": 0,
    "order_count": 0,
    "order_ids": [],
    "bag_ids": [],
    "transfers": []
  }
}