NovoPayment Merchant API

The Merchant API from NovoPayment — 1 operation(s) for merchant.

GitHub OpenAPI

Operations 1

POST /merchant Create Merchant Customers #

Documentation

📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/customers-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/customers-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-merchant-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-merchant-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'The Customers API allows to handle the different type of customers that can be served by NovoPayment’s platform. This includes individuals, commercial and merchant customers. For most of the operations to be performed in the platform you will need to provide the customer id in order to complete the operation.


    Below operations are available for Customers API


    **Create Commercial Customers**


    This operation can be used for commercial customer creation.


    **Create Merchant Customers**


    This operation can be used to create a merchant customer type.


    **Create Individual Customers**


    This operation can be used to create an individual customer type.


    **Customer Employment Information Update**


    This operation updates the customer work information for the tenant´s administration staff.


    **Get Customer Action Logs**


    This operation allows to consult the list of actions carried out by the customer in all the options of the application.


    **Get Customer Risk Indicators**


    This operation allows to consult the customer''s risk information studied by the anti-money laundering system (AML).


    **Get List of Customers**


    This operation allows to consult the information of all the customers that have registered into the system, these customers may have or may have not associated any account and card.


    **Get Supporting Documents**


    This operation allows to consult the list of support documents mandatories established by the tenant to validate the customer''s profile (Utility bill, Proof of employment, etc.).


    **Get a Customer Document**


    This operation allows to consult one of the customer''s support documents from a document id.'
  version: v1
  title: Customers Merchant API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/customers/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Merchant
paths:
  /merchant:
    post:
      summary: Create Merchant Customers
      description: Operation that allows to create a merchant type customer.
      requestBody:
        $ref: '#/components/requestBodies/RQCreateMerchantCustomer'
      operationId: CreateMerchantCustomers
      responses:
        '200':
          $ref: '#/components/responses/RSCreateMerchantCustomer200'
        '400':
          $ref: '#/components/responses/RSCreateMerchantCustomer400'
        '401':
          $ref: '#/components/responses/RS401'
        '500':
          $ref: '#/components/responses/RS500'
      tags:
      - Merchant
components:
  schemas:
    RS401:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 401.01.990
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Invalid Access Token
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSCreateMerchantCustomer400:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 400.18.003
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Params required
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RQCreateMerchantCustomer:
      type: object
      required:
      - legalName
      - tradingName
      - mcc
      - annualCardVolum
      - maxTransactionAmount
      - defaultStatementDescriptor
      - hasAcceptedCreditCardsPreviously
      - industryType
      - entityType
      - entityPurpose
      - registrationNumber
      - incorporationDate
      - identifications
      - webSite
      - contacts
      - addresses
      properties:
        legalName:
          type: string
          description: 'Legal name of the entity, just like is presented in the official documentation. Only letters, numbers and the following special characters are allowed: dash, apostrophes, period, coma and spaces.

            '
          example: commercial LegalName
          maxLength: 50
        tradingName:
          type: string
          description: 'Commercial name of the entity, the. Way it appears in official documentation Only letters, numbers and the following special characters are allowed: dash, apostrophes, period, coma and spaces.

            '
          example: commercial TradingName.
          maxLength: 50
        mcc:
          type: string
          description: Merchant Category Code that this merchant will be classified under.
          example: 7834
          maxLength: 4
        annualCardVolum:
          type: number
          description: Approximate annual credit card sales expected to be processed in cents by this merchant.
          example: 1000
          maxLength: 12
        maxTransactionAmount:
          type: number
          description: Maximum amount that can be transacted for a single transaction in cents.
          example: 2000
          maxLength: 12
        defaultStatementDescriptor:
          type: string
          description: Billing descriptor displayed on the buyer’s bank or card statement.
          example: Prestige World Wide
          maxLength: 20
        hasAcceptedCreditCardsPreviously:
          type: boolean
          description: Defaults to false if not passed.
          example: true
        industryType:
          type: string
          description: '**Refer to:** [Industry Type](https://developer.novopayment.com/api/request-and-response-codes#item-industrytype)

            '
          example: 44122
          maxLength: 50
        entityType:
          type: string
          description: '**Refer to:** [Entity Type](https://developer.novopayment.com/api/request-and-response-codes#item-entitytype)

            '
          example: UNIQUE OWNER
          maxLength: 50
        entityPurpose:
          type: string
          description: commercial Purpose
          example: commercial Purpose
          maxLength: 50
        registrationNumber:
          type: string
          description: Tax id number or tax record number of the business.
          example: 9834092375230
          maxLength: 50
        incorporationDate:
          type: string
          description: Date of the business incorporation in ISO 8601 format.
          example: '2020-01-03T16:05:56.517Z'
        identifications:
          type: array
          description: This array allows to add more than one business id to a business BUSINESS_TAX_ID BUSINESS_NUMBER TAXPAYER_IDENTIFICATION_NUMBER.
          required:
          - type
          - value
          items:
            type: object
            properties:
              type:
                type: string
                description: 'Identification.


                  *Format:* BUSINESS_TAX_ID, BUSINESS_NUMBER o TAXPAYER_IDENTIFICATION_NUMBER

                  '
                enum:
                - BUSINESS_TAX_ID
                - BUSINESS_NUMBER
                - TAXPAYER_IDENTIFICATION_NUMBER
                maxLength: 50
              value:
                type: string
                description: Identification number associated to the format.
                example: XX-XXXXXXX
                maxLength: 50
        webSite:
          type: string
          description: Company website.
          example: https://by.com
          maxLength: 50
        contacts:
          type: array
          description: An array containing contact information.
          required:
          - type
          - value
          items:
            type: object
            properties:
              type:
                type: string
                description: A standard set of values that indicate the contact type [EMAIL, PHONE].
                enum:
                - EMAIL
                - PHONE
                maxLength: 50
              value:
                type: string
                description: 'If type is ''email'', string must be match email format, the ''+'' character is not allowed. If type is ''phone'', string must be in an international format, the + symbol and the 1-3 digit country calling code.

                  '
                example: email@email.com
                maxLength: 50
        addresses:
          type: array
          description: 'An array containing business''s addresses. Address should follow USPS normalization practices. (Example: "St" instead of "street", common unit designator "APT" instead of "apartment"). Periods "." are not allowed. Zip+4 is not required.

            '
          required:
          - addressType
          items:
            type: object
            properties:
              addressType:
                type: string
                description: Address type.
                example: RESIDENCE
                maxLength: 20
              addressLine1:
                type: string
                description: Address Line One.
                example: address line 1
                maxLength: 100
              addressLine2:
                type: string
                description: Address Line Two.
                example: address line 2
                maxLength: 100
              homeNumber:
                type: string
                description: House number.
                example: Office 124
                maxLength: 50
              buildingNumber:
                type: string
                description: Building number.
                example: Building C
                maxLength: 50
              city:
                type: string
                description: City.
                example: New York
                maxLength: 100
              zipCode:
                type: string
                description: ZIP code.
                example: 94398
                maxLength: 10
              country:
                type: string
                description: Country in ISO code 2 digits.
                example: US
                maxLength: 2
    RS500:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 500.01.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: '2020-01-03T16:05:56.517Z'
          description: Opertion Timestamp
          format: date-time
    RSCreateMerchantCustomer200:
      type: object
      required:
      - code
      - message
      - datetime
      - data
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.18.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
        data:
          type: object
          required:
          - customerId
          properties:
            customerId:
              type: string
              description: Unique customer identifier.
              example: 49BCD622C6A07726594D63AAB2F436D366782AD1
              maxLength: 40
  examples:
    AccessTokenExpired:
      value:
        code: 401.18.993
        message: Access token expired
        datetime: '2020-01-03T16:05:56.517Z'
    AccessTokenNotApproved:
      value:
        code: 401.18.991
        message: Access Token not approved
        datetime: '2020-01-03T16:05:56.517Z'
    InternalServerError:
      value:
        code: 500.18.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    ParameterFormatError:
      value:
        code: 400.18.081
        message: Parameter format error
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.18.992
        message: Invalid signature
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidAccessToken:
      value:
        code: 401.18.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
  responses:
    RSCreateMerchantCustomer200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSCreateMerchantCustomer200'
          examples:
            Success:
              value:
                code: 200.18.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
                data:
                  customerId: 49BCD622C6A07726594D63AAB2F436D366782AD1
    RSCreateMerchantCustomer400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSCreateMerchantCustomer400'
          examples:
            Parameter Format Error:
              $ref: '#/components/examples/ParameterFormatError'
    RS401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS401'
          examples:
            Invalid Access Token:
              $ref: '#/components/examples/InvalidAccessToken'
            Access Token Not Approved:
              $ref: '#/components/examples/AccessTokenNotApproved'
            Invalid Signature:
              $ref: '#/components/examples/InvalidSignature'
            Access Token Expired:
              $ref: '#/components/examples/AccessTokenExpired'
    RS500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerError'
  requestBodies:
    RQCreateMerchantCustomer:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQCreateMerchantCustomer'
      required: true
  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/customers-api/customers-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)