Skip to main content
POST
/
api
/
v1
/
payment
/
quote
Create a payment quote
curl --request POST \
  --url http://localhost:45000/api/v1/payment/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fundingType": "<string>",
  "amount": "<string>",
  "currencyCode": "<string>",
  "paymentSystemId": "<string>",
  "customerId": "<string>"
}
'
{
  "id": "<string>",
  "paymentAmount": "<string>",
  "paymentCurrencyCode": "<string>",
  "totalTarget": "<string>",
  "targetCurrencyCode": "<string>",
  "createdAt": "<string>",
  "expiresAt": "<string>",
  "usedAt": "<string>",
  "priceBreakdown": {
    "payout": {
      "label": "<string>",
      "amountUsd": "<string>"
    },
    "platformFees": {
      "feeProfileId": "<string>",
      "feeProfileName": "<string>",
      "subtotalUsd": "<string>",
      "lines": [
        {
          "feeRuleId": "<string>",
          "name": "<string>",
          "feeValue": "<string>",
          "baseAmountUsd": "<string>",
          "rawAmountUsd": "<string>",
          "minAmountUsd": "<string>",
          "maxAmountUsd": "<string>",
          "finalAmountUsd": "<string>",
          "paymentSystemId": "<string>"
        }
      ]
    },
    "partnerFees": {
      "feeProfileId": "<string>",
      "feeProfileName": "<string>",
      "subtotalUsd": "<string>",
      "lines": [
        {
          "feeRuleId": "<string>",
          "name": "<string>",
          "feeValue": "<string>",
          "baseAmountUsd": "<string>",
          "rawAmountUsd": "<string>",
          "minAmountUsd": "<string>",
          "maxAmountUsd": "<string>",
          "finalAmountUsd": "<string>",
          "paymentSystemId": "<string>"
        }
      ]
    },
    "funding": {
      "subtotalUsd": "<string>",
      "lines": [
        {
          "feeRuleId": "<string>",
          "name": "<string>",
          "feeValue": "<string>",
          "baseAmountUsd": "<string>",
          "rawAmountUsd": "<string>",
          "minAmountUsd": "<string>",
          "maxAmountUsd": "<string>",
          "finalAmountUsd": "<string>",
          "paymentSystemId": "<string>"
        }
      ]
    },
    "totals": {
      "fundingType": "<string>",
      "feesUsd": "<string>",
      "totalTarget": "<string>",
      "targetCurrencyCode": "<string>",
      "effectivePriceUsdPerToken": "<string>",
      "quotedTokenAmount": "<string>"
    }
  },
  "fundingType": "<string>",
  "networkFeeUsd": "<string>",
  "effectivePriceUsdPerToken": "<string>",
  "quotedTokenAmount": "<string>",
  "paymentSystemId": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Nuvera API application secret key

​
Authorization
string
header
required

RS256 per-request signed JWT

Body

application/json
​
fundingType
string
required
Allowed value: "CRYPTO"
​
amount
string
required

USD payout amount before fees

​
currencyCode
string
required
Allowed value: "USD"
​
paymentToken
enum<string>
required
Available options:
USDC,
USDT
​
paymentNetwork
enum<string>
required
Available options:
ETHEREUM,
ETHEREUM_SEPOLIA,
POLYGON,
POLYGON_AMOY,
SOLANA,
SOLANA_DEVNET,
TRON,
TRON_NILE
​
paymentSystemId
string
​
customerId
string

Response

default - application/json
​
id
string
required
​
paymentAmount
string
required
​
paymentCurrencyCode
string
required
​
totalTarget
string
required
​
targetCurrencyCode
string
required
​
createdAt
string
required
​
expiresAt
string
required
​
usedAt
string | null
required
​
priceBreakdown
object
required
​
fundingType
string
required
Allowed value: "CRYPTO"
​
paymentToken
enum<string>
required
Available options:
USDC,
USDT
​
paymentNetwork
enum<string>
required
Available options:
ETHEREUM,
ETHEREUM_SEPOLIA,
POLYGON,
POLYGON_AMOY,
SOLANA,
SOLANA_DEVNET,
TRON,
TRON_NILE
​
networkFeeUsd
string
required
​
effectivePriceUsdPerToken
string
required
​
quotedTokenAmount
string
required
​
paymentSystemId
string | null
required