> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kirafin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Payout values

> Every value set a payout field accepts or returns, and what each value means.

The values each enumerated field on a payout takes. Check it when you are branching on a field's value or filtering a listing.

## payout `status`

Where a payout has got to. The same values filter a listing and come back on each row.

<Accordion title="View the 8 payout status values">
  | Value         | Description                         |
  | ------------- | ----------------------------------- |
  | `CREATED`     | Recorded, not started yet.          |
  | `PENDING`     | Waiting to be sent.                 |
  | `PROCESSING`  | On its way to the recipient.        |
  | `COMPLETED`   | The recipient has the money.        |
  | `FAILED`      | It did not go through.              |
  | `CANCELLED`   | Stopped before it was sent.         |
  | `IN_REVIEW`   | Held for a manual check.            |
  | `KYT_PENDING` | Held while a compliance check runs. |
</Accordion>

## payout `origin`

What started the payout.

| Value     | Description                                         |
| --------- | --------------------------------------------------- |
| `deposit` | A deposit into a virtual account triggered it.      |
| `payout`  | A payout from a virtual account.                    |
| `api`     | A direct call, with no virtual account in the flow. |

## `nature_of_payment`

What the payout is for. It decides whether a supporting document is required.

<Accordion title="View the 7 nature_of_payment values">
  | Value              | Description                                                                                       |
  | ------------------ | ------------------------------------------------------------------------------------------------- |
  | `vendor`           | Paying a supplier.                                                                                |
  | `pobo`             | Paying on behalf of one of your own customers.                                                    |
  | `first_party`      | Moving your own money to yourself. A crypto payout with this nature needs no supporting document. |
  | `spot_3p`          | A one-off payment to somebody else.                                                               |
  | `spot_1p`          | A one-off payment to yourself.                                                                    |
  | `related_entities` | Between companies under the same ownership.                                                       |
  | `other`            | Anything else.                                                                                    |
</Accordion>

## payout `payment_method`

Which rail the payout went out on, taken from the recipient. It comes back in lower case.

| Value    | Description                 |
| -------- | --------------------------- |
| `ach`    | A US bank account over ACH. |
| `wire`   | A bank account by wire.     |
| `wallet` | A crypto wallet.            |