Step 1 - Create a quote

You need to create a quote to understand the cost of the transaction and the foreign exchange rate that will be applied to it.

A quote has an expiration time, and you can create a payment associated with this quote while it is not expired.

Quote types

When considering quotations for a quick start, there are two main types to keep in mind, SENDER_AMOUNT and RECEIVING_AMOUNT

Sender Amount (SENDER_AMOUNT)

The amount is initially quoted in the source currency, and then the fee and foreign exchange rate are applied to determine the received amount in the target currency. After settling the payment, we will deduct the quoted amount from your balance.

Receiving Amount (RECEIVING_AMOUNT)

The amount is initially quoted in the target currency, and the beneficiary will receive this exact amount. However, the amount deducted from your balance will be in the source currency, applying the foreign exchange rate plus any applicable fees.

API call

Quote a payment.

post

Authorizations

oauth2-implicitoauth2-client-credentials

Body

application/json-patch+jsonapplication/jsonapplication/*+json

payerIdinteger · int32Optional

paymentTypestring · enumOptionalPossible values:

sourceCurrencystringOptional

targetCountrystringOptional

targetCurrencystringOptional

sellerCurrencystringOptional

collectMethodstring · enumOptionalPossible values:

quoteTypestring · enumOptionalPossible values:

quoteAmountnumber · doubleOptional

sellerSpreadnumber · doubleOptional

sellerCountrystringOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

post

HTTPcURLJavaScriptPython

POST /api/QuoteCollections HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 242

{
  "payerId": 1,
  "paymentType": "C2C",
  "sourceCurrency": "text",
  "targetCountry": "text",
  "targetCurrency": "text",
  "sellerCurrency": "text",
  "collectMethod": "CASH_PICKUP",
  "quoteType": "SENDER_AMOUNT",
  "quoteAmount": 1,
  "sellerSpread": 1,
  "sellerCountry": "text"
}

application/json-patch+jsonapplication/jsonapplication/*+json

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "text",
    "createdAt": "2025-05-04T02:28:11.673Z",
    "expiresAt": "2025-05-04T02:28:11.673Z",
    "sourceCurrency": "text",
    "targetCurrency": "text",
    "targetCountry": "text",
    "collectMethod": "CASH_PICKUP",
    "payerId": 1,
    "type": "SENDER_AMOUNT",
    "amount": 1,
    "liquidityWarning": true,
    "quoteElements": [
      {
        "sendingAmount": 1,
        "sendingCurrency": "text",
        "receivingAmount": 1,
        "receivingCurrency": "text",
        "sendingFee": 1,
        "receivingFee": 1,
        "fxRate": 1,
        "sourceToUSD": 1,
        "amountUSD": 1,
        "sellerCurrency": "text",
        "sellerFx": 1,
        "sellerCountry": "text",
        "SellerVATFee": 1,
        "SellerVATPercent": 1
      }
    ]
  }
]