---
title: "Create Payout Quote"
method: POST
path: "/payments/v2/payout/quote"
tags: ["Payouts"]
---

# Create Payout Quote

`POST /payments/v2/payout/quote`

## Request

- Base URL: `https://api-sandbox.payretailers.com`
- URL: `https://api-sandbox.payretailers.com/payments/v2/payout/quote`
- Auth: one of:
  - HTTP basic
  - API key in header `X-API-Key`

Generate a fixed-rate FX quote for a payout transaction. Quote is valid for 5 minutes.

## Request body

- PayoutQuoteRequest
  - `country` string, required: ISO 3166-1 alpha-2 country code
  - `amount` number, double, required: Payout amount in the request currency
  - `currencyCode` string, required: ISO 4217 currency code
  - `payoutChannel` 'TRANSFER' | 'WALLET' | 'CARD', required: Payout delivery method
  - `merchantSpreadPercent` number, double, required: Merchant's FX spread percentage

## Response `200`

Quote successfully created

- PayoutQuoteResponse
  - `payoutQuoteId` string, uuid, required: Unique quote identifier
  - `createdAt` string, date-time, required: Quote creation timestamp (ISO 8601 with timezone)
  - `expiresAt` string, date-time, required: Quote expiration timestamp (ISO 8601 with timezone)
  - `expiresInSeconds` integer, required: Seconds until quote expires
  - `country` string, required: ISO 3166-1 alpha-2 country code
  - `requestAmount` number, double, required: Original requested amount
  - `requestCurrency` string, required: Original request currency (ISO 4217)
  - `targetCurrency` string, required: Target payout currency (ISO 4217)
  - `payoutChannel` 'TRANSFER' | 'WALLET' | 'CARD', required: Payout delivery method
  - `merchantSpreadPercent` number, double, required: Merchant's FX spread percentage
  - `fxBreakdown` FxBreakdown, required
    - `exchangeRate` number, double, required: Final exchange rate applied
    - `components` FxComponents, required
      - `merchantSpreadPercent` number, double, required: Merchant's FX spread percentage
      - `pspSpreadPercent` number, double, required: PSP's FX spread percentage
      - `localTaxPercent` number, double, required: Local tax percentage
      - `operationFeePercent` number, double, required: Operation fee percentage
    - `contexts` FxContexts, required
      - `base` object, required: Amounts in the request/base currency
        - `currency` string, required: ISO 4217 currency code for this context
        - `payoutAmount` number, double, required: Gross payout amount before fees
        - `merchantSpreadAmount` number, double, required: Merchant spread fee amount
        - `pspSpreadAmount` number, double, required: PSP spread fee amount
        - `localTaxAmount` number, double, required: Local tax amount
        - `operationFee` number, double, required: Operation fee amount
        - `netPayoutAmount` number, double, required: Net amount after all fees and taxes
      - `local` object, required: Amounts in the target/local currency
        - `currency` string, required: ISO 4217 currency code for this context
        - `payoutAmount` number, double, required: Gross payout amount before fees
        - `merchantSpreadAmount` number, double, required: Merchant spread fee amount
        - `pspSpreadAmount` number, double, required: PSP spread fee amount
        - `localTaxAmount` number, double, required: Local tax amount
        - `operationFee` number, double, required: Operation fee amount
        - `netPayoutAmount` number, double, required: Net amount after all fees and taxes

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/payretailers/apis/payretailers-payout-api.md) - [All operations](https://skmtc.dev/payretailers/apis/payretailers-payout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payretailers/apis/payretailers-payout-api/revisions/68f20160e615?raw)