v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Payouts

Create Payout Quote

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

post/payments/v2/payout/quote

Request body

countrystring required

ISO 3166-1 alpha-2 country code

amountnumber double required

Payout amount in the request currency

currencyCodestring required

ISO 4217 currency code

payoutChannel'TRANSFER' | 'WALLET' | 'CARD' required

Payout delivery method

merchantSpreadPercentnumber double required

Merchant's FX spread percentage

Example request

{
  "country": "BR",
  "amount": 1000,
  "currencyCode": "USD",
  "payoutChannel": "TRANSFER",
  "merchantSpreadPercent": 1.5
}

Response

Quote successfully created

payoutQuoteIdstring uuid required

Unique quote identifier

createdAtstring date-time required

Quote creation timestamp (ISO 8601 with timezone)

expiresAtstring date-time required

Quote expiration timestamp (ISO 8601 with timezone)

expiresInSecondsinteger required

Seconds until quote expires

countrystring required

ISO 3166-1 alpha-2 country code

requestAmountnumber double required

Original requested amount

requestCurrencystring required

Original request currency (ISO 4217)

targetCurrencystring required

Target payout currency (ISO 4217)

payoutChannel'TRANSFER' | 'WALLET' | 'CARD' required

Payout delivery method

merchantSpreadPercentnumber double required

Merchant's FX spread percentage

Example response

{
  "payoutQuoteId": "3a9e2f81-371d-40f0-b234-3a4d57f54a77",
  "createdAt": "2025-12-15T14:16:17.693008+00:00",
  "expiresAt": "2025-12-15T14:21:17.693008+00:00",
  "expiresInSeconds": 299,
  "country": "BR",
  "requestAmount": 1000,
  "requestCurrency": "USD",
  "targetCurrency": "BRL",
  "payoutChannel": "TRANSFER",
  "merchantSpreadPercent": 1.5,
  "fxBreakdown": {
    "exchangeRate": 5.39485,
    "components": {
      "merchantSpreadPercent": 1.5,
      "pspSpreadPercent": 2,
      "localTaxPercent": 0.38,
      "operationFeePercent": 0.5
    },
    "contexts": {
      "base": {
        "currency": "USD",
        "payoutAmount": 1000,
        "merchantSpreadAmount": 15,
        "pspSpreadAmount": 20,
        "localTaxAmount": 3.8,
        "operationFee": 5,
        "netPayoutAmount": 956.2
      },
      "local": {
        "currency": "USD",
        "payoutAmount": 1000,
        "merchantSpreadAmount": 15,
        "pspSpreadAmount": 20,
        "localTaxAmount": 3.8,
        "operationFee": 5,
        "netPayoutAmount": 956.2
      }
    }
  }
}