> For the complete documentation index, see [llms.txt](https://docs.violet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.violet.io/prism/payments/payments-during-checkout/transfers.md).

# Transfers

The Transfer object represents the movement of funds to a merchant after an Order has been processed. Transfers may occur immediately during checkout or asynchronously, depending on your configured payment flow.

You can retrieve or search for Transfer objects using the following APIs:

* [Get Transfer by Transfer ID](/api-reference/payments/transfers/get-transfer-by-id.md)
* [Get Transfer by Payment Provider Transfer ID](/api-reference/payments/transfers/get-transfer-by-payment-provider-transfer-id.md)
* [Search Transfers](/api-reference/payments/transfers/search-transfers.md)

Each of these endpoints returns a Transfer object containing key details such as status, amount, currency, related\_bags, and any associated errors. This object helps determine whether a merchant has received their distribution for a specific Bag.

### Understanding the Transfer object

#### Sample `Transfer`

```json
{
  "id": 93001,
  "payment_provider_id": "tr_1QMsWtKUtPkD123456789asdf",
  "payout_account_id": 1025,
  "amount": 3290,
  "currency": "USD",
  "status": "SENT",
  "payment_provider": "STRIPE",
  "related_orders": [
    "148830"
  ],
  "related_bags": [
    "139177"
  ],
  "related_distributions": [
    "87770"
  ],
  "date_created": "2024-11-19T14:35:47+0000",
  "date_last_modified": "2024-11-19T14:35:47+0000",
  "errors": [],
  "payment_service": "STRIPE",
  "external_id": "tr_1QMsWtKUtPkD123456789asdf"
}
```

The following data is available in a `Transfer` object:

| Field                          | Type             | Sample Value                 | Notes                                                                                                                                                   |
| ------------------------------ | ---------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `merchant_id`                  | Integer          | `12345`                      | The unique identifier of the merchant that this transfer is associated with.                                                                            |
| `payment_provider_transfer_id` | String           | `“wz_789xyz”`                | The unique identifier of the Transfer object in your payment provider.                                                                                  |
| `status`                       | String           | `SUCCESS` , `FAILED`         | Denotes what state the transfer is in. When associated to an `EXTERNAL` Transfer, this status is always `SUCCESS`                                       |
| `amount`                       | Integer          | `10000`                      | Amount transferred, in fractional currency unit (e.g. cents).                                                                                           |
| `currency`                     | String           | `“USD”`                      | Currency in which these funds were transferred.                                                                                                         |
| `related_bags`                 | List of Integers | `[12345, 12346, 18283]`      | Violet Bag IDs for which this transfer was processed.                                                                                                   |
| `related_orders`               | List of Integers | `[22345, 22346, 28283]`      | Violet Order IDs for which this transfer was processed.                                                                                                 |
| `related_distributions`        | List of Integers | `[1118941, 1231123, 181283]` | Violet Distribution IDs for which this transfer was processed. The Distributions are the specific amounts for each Bag that were owed to this merchant. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.violet.io/prism/payments/payments-during-checkout/transfers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.