NovoPayment Recipients API

The Recipients API from NovoPayment — 1 operation(s) for recipients.

GitHub OpenAPI

Operations 1

PUT /recipients/products/{productId}/decision Approve Or Decline A Recipient #

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-recipients-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-recipients-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 Recipients API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/customers/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Recipients
paths:
  /recipients/products/{productId}/decision:
    put:
      summary: Approve Or Decline A Recipient
      description: Use the endpoint to approve or decline a recipient of a specific account.
      requestBody:
        $ref: '#/components/requestBodies/RQApproveOrDeclineARecipient'
      operationId: ApproveOrDeclineARecipient
      parameters:
      - $ref: '#/components/parameters/productId'
      responses:
        '200':
          $ref: '#/components/responses/RSApproveOrDeclineARecipient200'
        '400':
          $ref: '#/components/responses/RSApproveOrDeclineARecipient400'
        '401':
          $ref: '#/components/responses/RS401'
        '500':
          $ref: '#/components/responses/RS500'
      tags:
      - Recipients
components:
  requestBodies:
    RQApproveOrDeclineARecipient:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQApproveOrDeclineARecipient'
      required: true
  responses:
    RSApproveOrDeclineARecipient200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSApproveOrDeclineARecipient200'
          examples:
            Success:
              value:
                code: 200.18.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
    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'
    RSApproveOrDeclineARecipient400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSApproveOrDeclineARecipient400'
          examples:
            Header Params Required:
              $ref: '#/components/examples/HeaderParamsRequired'
            Open Escalations Exist:
              $ref: '#/components/examples/OpenEscalationsExist'
            Requested Resource Not Found:
              $ref: '#/components/examples/RequestedResourceNotFound'
            Product Status Not Updated:
              $ref: '#/components/examples/ProductStatusNotUpdated'
  examples:
    InternalServerError:
      value:
        code: 500.18.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.18.992
        message: Invalid signature
        datetime: '2020-01-03T16:05:56.517Z'
    OpenEscalationsExist:
      value:
        code: 400.18.035
        message: Open escalations exist.
        datetime: '2020-01-03T16:05:56.517Z'
    RequestedResourceNotFound:
      value:
        code: 400.18.022
        message: The requested resource was not found.
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidAccessToken:
      value:
        code: 401.18.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
    ProductStatusNotUpdated:
      value:
        code: 400.18.317
        message: Product status could not be updated.
        datetime: '2020-01-03T16:05:56.517Z'
    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'
    HeaderParamsRequired:
      value:
        code: 400.18.001
        message: Header Params Required
        datetime: '2020-01-03T16:05:56.517Z'
  parameters:
    productId:
      name: productId
      in: path
      description: A unique identifier that associates the data from the product with the recipient.
      required: true
      schema:
        type: integer
        example: 221BF87320F278DC9F41C835AD0D5111B2B0FF68
        maxLength: 38
  schemas:
    RSApproveOrDeclineARecipient200:
      type: object
      required:
      - code
      - message
      - datetime
      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
    RQApproveOrDeclineARecipient:
      type: object
      required:
      - actionId
      - comments
      - updatedBy
      properties:
        actionId:
          type: integer
          description: 'Action to perform


            **Allowed values:**


            0: Decline


            1: Approve

            '
          enum:
          - 0
          - 1
          maxLength: 200
        comments:
          type: string
          description: Comments related to the action.
          example: Invalid Recipient.
          maxLength: 200
        updatedBy:
          type: string
          description: The user who performs the action.
          example: Master
          maxLength: 100
    RSApproveOrDeclineARecipient400:
      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
    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
    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
  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)