NovoPayment Universal API

The Universal API from NovoPayment — 1 operation(s) for universal.

GitHub OpenAPI

Operations 1

POST /universal/core/cards/encryption Encrypt card #

Documentation

📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/tokenization/push-provisioning-api-v1.0

Specifications

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/novopayment:novopayment-universal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

novopayment-universal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Push Provisioning Universal API
  description: '## Use Cases ##

    If you are a Bank that wants to give your customers the possibility to

    seamless register their debit and credit cards in payment platforms such as

    Apple Pay, Samsung Pay and Google Pay, as easily as including only one button

    on your website or app, this API is the solution. NovoPayment does the heavy

    lifting for you, we take care of providing the service for you, so you can

    focus on the core of your business and the UX/UI.


    ## Benefits for you ##

    NovoPayment Push Provisioning manages the interaction with the card schemes

    for you and allows you to focus on the core of your business, freeing you

    from the effort of interconnection with each third-party wallet and allowing

    your customers to quickly access the benefits of using gadgets with NFC

    technology.


    ## What do you need to start the project? ##


    1. Register and create a project in NovoPayment’s Developer Hub. Select

    "Novo Push Provisioning", if the option is not available, please contact us.

    2. Perform tests in the sandbox environment for the following operations:

    - Manage the associated cards of a customer.

    1. Register a new card

    2. Delete a registered card

    - Link a card in Apple Pay

    - Link a card in Google Pay

    - Link a card in Samsung Pay

    3. At the time included in your app the services with which you want to

    integrate, by negotiating with the chosen wallet, for example, Apple Pay.

    4. After testing, contact us to deploy to the UAT environment and start the

    certification process with the third party wallet.


    ## System Overview ##


    Push Provisioning (also call in-app provisioning) allows consumers to easily

    add/push their cards to any supported wallets including Apple Pay, Google

    Pay and Samsung Pay - in-app with the click of a button.


    Implementing this API in your wallet allows your clients to enroll their

    cards in Google Pay, Samsung Pay and Apple Pay.


    ## Headers Params ##

    **Header fields**

    | Name | Description | Value | Required/Optional/Conditional |

    |------------------|--------------------------------------------------------------|--------------------------------------|-------------------------------|

    | Accept-Language | Language used. | en | Required |

    | Content-Type | Response body type. Operation related information. | application/json | Required |

    | Accept | Content types that are acceptable related to this operation.| application/json | Conditional |

    | Authorization | Application authentication information based on the RFC6750 OAUTH 2 specification, under the client’s credentials. | ''Bearer '' + accesToken | Required |

    | X-Token | Application authentication information based on the RFC7515 JWS under petition signature. | ''JWS '' + token | Required |

    | X-Tenant-Id | Identifies the tenant that is calling the operation. | | Required |

    | X-Time-Zone | Time Zone of the request. | | Optional |

    | X-Request-Id | Unique ID for the API request. This ID is the reference in all the API’s processes. | String (1-36) | Optional |'
  version: v1.0
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/pushprovisioning/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Universal
paths:
  /universal/core/cards/encryption:
    post:
      summary: Encrypt card
      description: This endpoint returns the card information in an encrypted form.
      operationId: EncryptCard
      requestBody:
        $ref: '#/components/requestBodies/RQEncryptCard'
      responses:
        '200':
          $ref: '#/components/responses/RSEncryptCard200'
        '400':
          $ref: '#/components/responses/RSEncryptCard400'
        '401':
          $ref: '#/components/responses/RSEncryptCard401'
        '500':
          $ref: '#/components/responses/RSEncryptCard500'
      tags:
      - Universal
components:
  examples:
    InvalidSignatureTk:
      value:
        code: 401.00.992
        message: Invalid signature
        datetime: '2024-07-17T00:57:36.360Z'
    EncryptionError:
      value:
        code: 400.00.994
        message: Encryption error
        datetime: '2024-07-17T00:57:36.360Z'
    DecryptionError:
      value:
        code: 401.00.997
        message: Decryption Error
        datetime: '2024-07-17T00:57:36.360Z'
    ErrorGeneralService:
      value:
        code: 400.00.350
        message: Error General Service.
        datetime: '2022-04-25T23:19:12.000Z'
    InvalidParams:
      value:
        code: 400.00.396
        message: Invalid parameters.
        datetime: '2024-07-17T00:57:36.360Z'
    ConfigurationNotFound:
      value:
        code: 400.00.356
        message: Component configuration not found.
        datetime: '2024-07-17T00:57:36.360Z'
    HeaderParamsRequiredTk:
      value:
        code: 400.00.001
        message: Header Params Required
        datetime: '2022-04-25T23:19:12.000Z'
    InternalServerErrorTk:
      value:
        code: 500.00.999
        message: Internal Server Error
        datetime: '2022-04-25T23:19:12.000Z'
  responses:
    RSEncryptCard500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500Tk'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerErrorTk'
    RSEncryptCard400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS400Tk'
          examples:
            Header Params Required:
              $ref: '#/components/examples/HeaderParamsRequiredTk'
            Error General Service:
              $ref: '#/components/examples/ErrorGeneralService'
            Invalid parameters:
              $ref: '#/components/examples/InvalidParams'
            Component configuration not found:
              $ref: '#/components/examples/ConfigurationNotFound'
            Encryption error:
              $ref: '#/components/examples/EncryptionError'
    RSEncryptCard401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS401Tk'
          examples:
            Invalid signature:
              $ref: '#/components/examples/InvalidSignatureTk'
            Decryption Error:
              $ref: '#/components/examples/DecryptionError'
    RSEncryptCard200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSEncryptCard200'
          examples:
            Default:
              value:
                code: 200.00.000
                message: Process Ok
                datetime: '2022-04-25T23:19:12.000Z'
                data:
                  signedPayload: eyJle...y3fmkg
  schemas:
    ObjCardEncryptionEncryptedData:
      type: object
      description: 'Encrypted and signed request data

        '
      required:
      - signedNonce
      - accountNumber
      - expirationMonth
      - expirationYear
      - nameOnAccount
      - cardType
      - cardBrand
      - billingAddress
      properties:
        signedNonce:
          type: string
          maxLength: 256
          description: 'Nonce signed with signature shared secret

            '
          example: eyJle...XcClc
        accountNumber:
          type: string
          maxLength: 19
          description: 'Full Card Number, numeric value

            '
          example: '4012888888881881'
        expirationMonth:
          type: string
          maxLength: 2
          description: 'Month when the card is set to expire

            '
          example: '02'
        expirationYear:
          type: string
          maxLength: 4
          description: 'Year when the card is set to expire

            '
          example: '2025'
        nameOnAccount:
          type: string
          maxLength: 256
          description: "Full name on the card, alphanumeric value with no \nspecial characters\n"
          example: John Doe
        cardType:
          type: string
          maxLength: 20
          enum:
          - DEBIT
          - CREDIT
          - PREPAID
        cardBrand:
          type: string
          maxLength: 20
          enum:
          - VISA
          - MC
        billingAddress:
          $ref: '#/components/schemas/ObjBillingAddressEnablement'
        user:
          $ref: '#/components/schemas/ObjUserEnablement'
    RS401Tk:
      type: object
      properties:
        code:
          type: string
          example: 401.00.992
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Invalid signature
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          example: '2022-04-25T23:19:12.000Z'
          minLength: 24
          maxLength: 24
    ObjSignedPayload:
      type: object
      required:
      - signedPayload
      properties:
        signedPayload:
          type: string
          description: 'Encrypted and signed card information

            '
          example: eyJle...y3fmkg
    RSEncryptCard200:
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.00.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: 'Operation Time Stamp in ISO 8601 format


            date-time - the date-time notation as defined by

            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6),

            for example, 2017-07-21T17:32:28Z

            '
          example: '2022-04-25T23:19:12.000Z'
          minLength: 24
          maxLength: 24
        data:
          $ref: '#/components/schemas/ObjSignedPayload'
    RQEncryptCard:
      type: object
      required:
      - encryptedData
      properties:
        encryptedData:
          $ref: '#/components/schemas/ObjCardEncryptionEncryptedData'
    RS500Tk:
      type: object
      properties:
        code:
          type: string
          example: 500.00.999
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Internal Server Error
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          example: '2022-04-25T23:19:12.000Z'
          minLength: 24
          maxLength: 24
    RS400Tk:
      type: object
      properties:
        code:
          type: string
          example: 400.00.001
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Header Params Required
          maxLength: 140
        datetime:
          type: string
          example: '2022-04-25T23:19:12.000Z'
          description: 'Operation Time Stamp in ISO 8601 format<br>date-time - the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z

            '
          minLength: 24
          maxLength: 24
    ObjBillingAddressEnablement:
      type: object
      required:
      - addressLine1
      - stateProvinceCode
      - postalCode
      - city
      - phoneNumber
      properties:
        addressLine1:
          type: string
          maxLength: 140
          description: 'Line 1 of the billing address (Must use UTF-8 characters)

            '
          example: 5 Central Drive
        stateProvinceCode:
          type: string
          maxLength: 3
          description: "Must be in ISO 3166-2 format, alphabetic value with max length of 3 characters, \nwith no dashes or spaces\n"
          example: NC
        postalCode:
          type: string
          maxLength: 16
          description: 'U.S.: 5-digit numeric value (e.g. 94100), spaces not allowed.

            Canada: 6-digit alphanumeric value (e.g. M4B1B3), spaces allowed.

            Other countries: 5-16 digit alphanumeric value without special characters, spaces allowed.

            '
          example: '27265'
        countryCode:
          type: string
          maxLength: 3
          description: 'Must be in ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 or ISO 3-digit numeric format

            '
          example: '840'
        city:
          type: string
          maxLength: 100
          description: 'City of the billing address, no special characters

            '
          example: High Point
        phoneNumber:
          type: string
          maxLength: 32
          description: 'Cardholder phone number including country code

            '
          example: 336-222-6060
    ObjUserEnablement:
      type: object
      required:
      - firstName
      - lastName
      - email
      - phoneNumber
      properties:
        firstName:
          type: string
          maxLength: 20
          description: 'Required for VCEH

            '
          example: Lewis
        lastName:
          type: string
          maxLength: 20
          description: 'Required for VCEH

            '
          example: Schultz
        email:
          type: string
          maxLength: 256
          description: 'Required for VCEH

            '
          example: lschultz@gmail.com
        phoneNumber:
          type: string
          maxLength: 32
          description: 'Required for VCEH

            '
          example: 336-222-6060
  requestBodies:
    RQEncryptCard:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQEncryptCard'
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: 'See [Oauth2 API](https://developer.novopayment.com/api/authentication-method-and-encryption/oauth2-api)

        '
      flows:
        clientCredentials:
          tokenUrl: https://sandbox-api.novopayment.com/oauth2/token
          scopes: {}
x-provenance:
  method: harvested
  publisher: NovoPayment
  source: https://dcrpi6aufyoyb.cloudfront.net/main/push-provisioning/push-provisioning-api-spec-v1.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)