# What a payout would cost, as a quote that binds the instruction

`POST /payouts/quote` · Skerry · Paying out

What a payout would cost, as a quote that binds the instruction. The answer carries `quote_id` and `valid_until` (120 seconds by default); `POST /payouts` with that `quote_id` executes exactly the quoted customer, amount, source, destination and rail, once. For a bank payout it says which rail it would leave on and why (`rail`, `rail_reason`) and carries the name check on the payee (`payee_check`). `fee`, `rate` and the receive amount are what the provider's dry run reported when the quote was made; the provider is not asked to hold them, so this is not a guaranteed rate. `amount` is a decimal string and `amount_minor` the same in integer minor units of the source currency; send either. `fee_minor` is in minor units of `fee_currency`, `receive_amount_minor` of `receive_currency`.

- Scope: payouts:write
- Moves money: no
- Idempotency: none
- Untrusted: payee_check

## Request body

`application/json`

```json
{
  "type": "object",
  "required": [
    "customer_id",
    "from",
    "to"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 200
    },
    "amount": {
      "type": "string",
      "pattern": "^\\d{1,18}(\\.\\d{1,10})?$",
      "description": "The amount as a decimal string in `from.currency`. Send this or `amount_minor`."
    },
    "amount_minor": {
      "type": "integer",
      "minimum": 1,
      "description": "The same amount in integer minor units of `from.currency`."
    },
    "from": {
      "type": "object",
      "required": [
        "currency",
        "wallet_id"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "description": "A lowercase currency code or stablecoin ticker."
        },
        "wallet_id": {
          "type": "string",
          "maxLength": 200
        }
      }
    },
    "to": {
      "type": "object",
      "required": [
        "currency"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "description": "A lowercase currency code or stablecoin ticker."
        },
        "payee_id": {
          "type": "string",
          "maxLength": 200
        },
        "wallet_id": {
          "type": "string",
          "maxLength": 200
        },
        "address": {
          "type": "string",
          "maxLength": 200
        },
        "chain": {
          "type": "string",
          "maxLength": 40
        }
      },
      "description": "Exactly one of `payee_id`, `wallet_id` or `address`."
    },
    "rail": {
      "type": "string",
      "maxLength": 40
    },
    "speed": {
      "type": "string",
      "enum": [
        "fastest",
        "cheapest",
        "standard"
      ]
    }
  }
}
```

## Responses

- `200`: Success.
- `202`: requires_approval — Not an error: the operation is held for a person. The body names the approval.
- `400`: price_below_minimum — The price is below the smallest single payment for a method (`detail.method`, `detail.minimum`), or has a part of a cent. Set `credit_only`, raise the price, or drop the method.
- `401`: dpop_invalid — The token is bound to a key and the DPoP proof was missing, wrong for this request, or already used.
- `402`: payment_failed — The payer's bank or card refused. `detail.reason` says why in plain terms.
- `403`: agent_payment_over_max — The merchant asks for more than `max_amount`. Nothing was signed. `detail.asked_minor` is the lowest price asked, in US cents.
- `404`: not_found — No such object in this project — including one that belongs to somebody else.
- `409`: token_not_issued — A delegated payment token could not be issued ready to use, for instance because the payer would have to act. Nothing was sent to the merchant.
- `429`: too_many_waiters — This key already has as many requests waiting (`?wait=`) as it may. Let one finish, or read without wait.
- `500`: internal_error — Ours. Quote the `request_id` and we can find the call.
- `502`: platform_error — A provider failed. Safe to retry with the same Idempotency-Key.
- `503`: oauth_unavailable — The authorisation server's keys could not be read, so tokens cannot be checked. API keys still work.

## Example

```sh
curl -X POST 'https://api.skerry.xyz/payouts/quote' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '"{ customer_id, amount | amount_minor, from, to, rail?, speed? }"'
```