Nuvei

Nuvei User Payment Options API

Manages stored payment instruments (User Payment Options / UPOs) including card and APM tokenization. Supports addUPOCreditCard, addUPOAPM, editUPOCreditCard, editUPOAPM, deleteUPO, getUserUPOs, and enableUPO/disableUPO.

GitHub OpenAPI

Operations 8

POST /addUPOCreditCard.do Add Credit Card UPO #
POST /addUPOAPM.do Add APM UPO #
POST /editUPOCreditCard.do Edit Credit Card UPO #
POST /editUPOAPM.do Edit APM UPO #
POST /deleteUPO.do Delete UPO #
POST /getUserUPOs.do Get User UPOs #
POST /enableUPO.do Enable UPO #
POST /disableUPO.do Disable UPO #

Documentation

📖
Documentation
https://docs.nuvei.com/documentation/integration/server-to-server/server-to-server-introduction/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nuvei/refs/heads/main/openapi/nuvei-user-payment-options-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/nuvei-user-payment-options-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

nuvei-user-payment-options-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nuvei 3DS User Payment Options API
  description: 3D Secure 2 authentication endpoints supporting PSD2 SCA.
  version: '1.0'
  contact:
    name: Nuvei Developer Support
    url: https://docs.nuvei.com
servers:
- url: https://secure.safecharge.com/ppp/api/v1
  description: Production
- url: https://ppp-test.nuvei.com/ppp/api/v1
  description: Sandbox
tags:
- name: User Payment Options
paths:
  /addUPOCreditCard.do:
    post:
      tags:
      - User Payment Options
      summary: Add Credit Card UPO
      operationId: addUPOCreditCard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUPOCardRequest'
      responses:
        '200':
          description: UPO created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /addUPOAPM.do:
    post:
      tags:
      - User Payment Options
      summary: Add APM UPO
      operationId: addUPOAPM
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUPOAPMRequest'
      responses:
        '200':
          description: UPO created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /editUPOCreditCard.do:
    post:
      tags:
      - User Payment Options
      summary: Edit Credit Card UPO
      operationId: editUPOCreditCard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditUPORequest'
      responses:
        '200':
          description: UPO updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /editUPOAPM.do:
    post:
      tags:
      - User Payment Options
      summary: Edit APM UPO
      operationId: editUPOAPM
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditUPORequest'
      responses:
        '200':
          description: UPO updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /deleteUPO.do:
    post:
      tags:
      - User Payment Options
      summary: Delete UPO
      operationId: deleteUPO
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUPORequest'
      responses:
        '200':
          description: UPO deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /getUserUPOs.do:
    post:
      tags:
      - User Payment Options
      summary: Get User UPOs
      operationId: getUserUPOs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserUPOsRequest'
      responses:
        '200':
          description: List of UPOs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserUPOsResponse'
  /enableUPO.do:
    post:
      tags:
      - User Payment Options
      summary: Enable UPO
      operationId: enableUPO
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleUPORequest'
      responses:
        '200':
          description: UPO enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
  /disableUPO.do:
    post:
      tags:
      - User Payment Options
      summary: Disable UPO
      operationId: disableUPO
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleUPORequest'
      responses:
        '200':
          description: UPO disabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPOResponse'
components:
  schemas:
    GetUserUPOsRequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
    AddUPOAPMRequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
      - type: object
        properties:
          paymentMethodName:
            type: string
          apmData:
            type: object
            additionalProperties: true
          billingAddress:
            type: object
    GetUserUPOsResponse:
      type: object
      properties:
        paymentMethods:
          type: array
          items:
            type: object
            properties:
              userPaymentOptionId:
                type: string
              upoName:
                type: string
              upoStatus:
                type: string
              upoRegistrationDate:
                type: string
              ccCardNumber:
                type: string
              ccExpMonth:
                type: string
              ccExpYear:
                type: string
              brand:
                type: string
              uniqueCC:
                type: string
              bin:
                type: string
              last4Digits:
                type: string
        status:
          type: string
          enum:
          - SUCCESS
          - ERROR
    DeleteUPORequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
      - type: object
        properties:
          userPaymentOptionId:
            type: string
    UPOResponse:
      type: object
      properties:
        userPaymentOptionId:
          type: string
        status:
          type: string
          enum:
          - SUCCESS
          - ERROR
        errCode:
          type: integer
        reason:
          type: string
        merchantId:
          type: string
        merchantSiteId:
          type: string
        version:
          type: string
        clientRequestId:
          type: string
        internalRequestId:
          type: integer
    MerchantAuth:
      type: object
      required:
      - merchantId
      - merchantSiteId
      - userTokenId
      - timeStamp
      - checksum
      properties:
        merchantId:
          type: string
        merchantSiteId:
          type: string
        userTokenId:
          type: string
        clientRequestId:
          type: string
        timeStamp:
          type: string
        checksum:
          type: string
    EditUPORequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
      - type: object
        properties:
          userPaymentOptionId:
            type: string
          ccExpMonth:
            type: string
          ccExpYear:
            type: string
          ccNameOnCard:
            type: string
          billingAddress:
            type: object
    AddUPOCardRequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
      - type: object
        properties:
          ccCardNumber:
            type: string
          ccExpMonth:
            type: string
          ccExpYear:
            type: string
          ccNameOnCard:
            type: string
          billingAddress:
            type: object
    ToggleUPORequest:
      allOf:
      - $ref: '#/components/schemas/MerchantAuth'
      - type: object
        properties:
          userPaymentOptionId:
            type: string