NovoPayment Recipients API

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.
  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
  examples:
    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'
    InvalidSignature:
      value:
        code: 401.18.992
        message: Invalid signature
        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'
    InternalServerError:
      value:
        code: 500.18.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    OpenEscalationsExist:
      value:
        code: 400.18.035
        message: Open escalations exist.
        datetime: '2020-01-03T16:05:56.517Z'
    HeaderParamsRequired:
      value:
        code: 400.18.001
        message: Header Params Required
        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'
  schemas:
    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
    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
    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
  responses:
    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'
    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'
    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'
  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
  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: {}