Nuvei · Schema

NuveiPayment

A Nuvei payment request payload.

PaymentsPayment ProcessingPayment GatewayAcquiringPayoutsAlternative Payment MethodsFraudRiskCurrency ConversioniGamingE-CommerceFintech

Properties

Name	Type	Description
merchantId	string	Merchant identifier assigned by Nuvei.
merchantSiteId	string	Site identifier for the merchant.
sessionToken	string	Token returned by getSessionToken / openOrder.
clientUniqueId	string	Idempotency key issued by the merchant.
clientRequestId	string
userTokenId	string
amount	string
currency	string
paymentOption	object
billingAddress	object
shippingAddress	object
deviceDetails	object
items	array
urlDetails	object
isRebilling	integer
timeStamp	string
checksum	string	SHA-256 over the ordered concatenation of fields plus the merchantSecretKey.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuvei/main/json-schema/nuvei-payment-schema.json",
  "title": "NuveiPayment",
  "description": "A Nuvei payment request payload.",
  "type": "object",
  "required": ["merchantId", "merchantSiteId", "amount", "currency", "timeStamp", "checksum"],
  "properties": {
    "merchantId": { "type": "string", "description": "Merchant identifier assigned by Nuvei." },
    "merchantSiteId": { "type": "string", "description": "Site identifier for the merchant." },
    "sessionToken": { "type": "string", "description": "Token returned by getSessionToken / openOrder." },
    "clientUniqueId": { "type": "string", "description": "Idempotency key issued by the merchant." },
    "clientRequestId": { "type": "string" },
    "userTokenId": { "type": "string" },
    "amount": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]{1,2})?$" },
    "currency": { "type": "string", "pattern": "^[A-Z]{3}$" },
    "paymentOption": {
      "type": "object",
      "properties": {
        "card": {
          "type": "object",
          "properties": {
            "cardNumber": { "type": "string" },
            "cardHolderName": { "type": "string" },
            "expirationMonth": { "type": "string" },
            "expirationYear": { "type": "string" },
            "CVV": { "type": "string" }
          }
        },
        "alternativePaymentMethod": { "type": "object" },
        "userPaymentOptionId": { "type": "string" }
      }
    },
    "billingAddress": { "$ref": "#/$defs/Address" },
    "shippingAddress": { "$ref": "#/$defs/Address" },
    "deviceDetails": {
      "type": "object",
      "properties": {
        "ipAddress": { "type": "string" },
        "deviceType": { "type": "string" },
        "deviceName": { "type": "string" },
        "deviceOS": { "type": "string" },
        "browser": { "type": "string" }
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "price": { "type": "string" },
          "quantity": { "type": "integer" }
        }
      }
    },
    "urlDetails": {
      "type": "object",
      "properties": {
        "successUrl": { "type": "string", "format": "uri" },
        "failureUrl": { "type": "string", "format": "uri" },
        "pendingUrl": { "type": "string", "format": "uri" },
        "notificationUrl": { "type": "string", "format": "uri" }
      }
    },
    "isRebilling": { "type": "integer", "enum": [0, 1] },
    "timeStamp": { "type": "string" },
    "checksum": { "type": "string", "description": "SHA-256 over the ordered concatenation of fields plus the merchantSecretKey." }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "properties": {
        "firstName": { "type": "string" },
        "lastName": { "type": "string" },
        "address": { "type": "string" },
        "city": { "type": "string" },
        "zip": { "type": "string" },
        "country": { "type": "string", "pattern": "^[A-Z]{2}$" },
        "email": { "type": "string", "format": "email" },
        "phone": { "type": "string" }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/nuvei-payment"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.