NovoPayment Accounts API

NovoPayment offers the Accounts API to provide a customized, scalable, light and portable set of functionalities. These functionalities can be used by financial institutions for supporting banking activities.

Operations 31

POST /customers/{customerId}/accounts Account and Card Creation #
GET /customers/{customerId}/accounts Account List #
GET /customers/{customerId}/accounts/{accountId} Account Information #
GET /customers/{customerId}/accounts/{accountId}/balance Account Balance #
POST /customers/{customerId}/accounts/{accountId}/block Block Account #
POST /customers/{customerId}/accounts/{accountId}/unblock Unblock Account #
GET /customers/{customerId}/accounts/{accountId}/transactions Account Transactions #
POST /customers/{customerId}/accounts/{accountId}/transactions Create Account To Account Transaction #
POST /customers/{customerId}/accounts/{accountId}/close Close Account #
GET /transfers/{transferId} Transfer Details #
GET /transactions Tenant Transactions #
POST /customers/{customerId}/cards/{cardId}/associate Card To Account Association #
POST /customers/{customerId}/cards/{cardId}/disassociate Card To Account Disassociation #
PUT /customers/{customerId}/cards/{cardId}/activate Card Activation #
POST /customers/{customerId}/cards/{cardId}/emboss Card Embossing #
POST /adjustments Credit Or Debit Adjustment #
POST /customers/{customerId}/cards/{cardId}/block Block Card #
POST /customers/{customerId}/cards Card Creation #
GET /customers/{customerId}/cards/{cardId} Card Detail #
POST /customers/{customerId}/cards/{cardId}/pin Card PIN Assignment #
PUT /customers/{customerId}/cards/{cardId}/pin Card PIN Update #
POST /customers/{customerId}/cards/{cardId}/replacement Card Replacement #
GET /customers/{customerId}/accounts/{accountId}/cards/{cardId}/securitcode Card Security Code CVV2 #
GET /customers/{customerId}/cards/{cardId}/transactions Card Transactions #
PUT /customers/{customerId}/cards/{cardId}/operationlimits Customize Card Operations Limits #
POST /customers/{customerId}/cards/{cardId}/unblock Unblock Card #
POST /cards/lookup Card Lookup
POST /cards/anonymous/batches Creation of Card Batches
GET /cards/anonymous/batches Card Batch List #
PUT /cards/anonymous/batches/{batchId}/status Anonymous Card Batch Status Update
GET /cards/anonymous/batches/{batchId} Card Batch Info #

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/accounts"
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.

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

OpenAPI Specification

novopayment-accounts-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: >
    NovoPayment offers the Accounts API to provide a customized,
    scalable, light and portable set of functionalities. These functionalities
    can be used by financial institutions for supporting banking activities.



    Below operations are available for Accounts API:



    * Self-Onboarding bank accounts


    * Digital account origination for virtual cards with dynamic CVV2


    * Internal transfers between banking accounts


    * Inter banking transfers (ACH)


    * International transfers (SWIFT)


    * Multiple P2P types



    Below operations are available for Accounts API:



    **Account and Card Creation**



    This operation can be used for new account creation.



    **Account Information**



    This operation can be used to obtain a list of a client’s accounts.



    **Account Balance**



    This operation can be used to retrieve the current account balance.



    **Block Account**



    This operation can be used to block an account.



    **Unblock Account**



    This operation can be used to unblock a currently blocked account.



    **Account Transactions**



    This operation can be used to retrieve a specific account’s transactions.



    **Create Transaction**



    This operation can be used to initiate a transaction.



    **Credit or Debit Adjustment**



    This operation can be used to make a credit adjustment (Cash-in) or debit adjustment (Cash-out) on the account.



    **Get Credit or Debit Adjustment**



    This operation can be used to obtain a list of all credit and debit adjustments successfully made.



    **Tenant Transactions**



    This operation can be used to list all the transactions for a tenant.



    **Transfer Details**



    This operation can be used to obtain details of a specific transaction.
  version: v1
  title: Accounts API
servers:
  - description: Sandbox
    url: https://sandbox-api.novopayment.com/accounts/v1
paths:
  "/customers/{customerId}/accounts":
    post:
      tags:
        - Accounts
      summary: Account and Card Creation
      description: >
        Leveraging a unique customer ID created during client onboarding,
        and account and card programs created with the Programs API, accounts
        can be created for individuals or businesses using the Accounts API if
        NovoPayment’s Virtual Account Opening using the Onboarding API was not
        used. The operation can include creating only the account or creating an
        account and issuing a debit card.
      requestBody:
        $ref: "#/components/requestBodies/RQAccountCreation"
      operationId: AccountCreation
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountCreation200"
        "400":
          $ref: "#/components/responses/RSAccountCreation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    get:
      tags:
        - Accounts
      summary: Account List
      description: >
        Allows your system or an administrator to retrieve all the accounts
        associated with a specific customer and information about each of the
        accounts, such as the account number, type of account, date created,
        programs, cards associated, etc.
      operationId: AccountList
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountList200"
        "400":
          $ref: "#/components/responses/RSAccountList400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}":
    get:
      tags:
        - Accounts
      summary: Account Information
      description: |
        This operation allows to get the account information.
      operationId: AccountInformation
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountInformation200"
        "400":
          $ref: "#/components/responses/RSAccountInformation400"
        "401":
          $ref: "#/components/responses/RS401"
        "404":
          $ref: "#/components/responses/RSAccountInformation404"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/balance":
    get:
      tags:
        - Accounts
      summary: Account Balance
      description: |
        This operation allows to retrieve the current account balance.
      operationId: AccountBalance
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountBalance200"
        "400":
          $ref: "#/components/responses/RSAccountBalance400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/block":
    post:
      tags:
        - Accounts
      summary: Block Account
      description: |
        This operation allows blocking temporary or permanent an account.
      requestBody:
        $ref: "#/components/requestBodies/RQBlockAccount"
      operationId: BlockAccount
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSBlockAccount200"
        "400":
          $ref: "#/components/responses/RSBlockAccount400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/unblock":
    post:
      tags:
        - Accounts
      summary: Unblock Account
      description: |
        This operation allows to unblock a currently blocked account.
      requestBody:
        $ref: "#/components/requestBodies/RQUnblockAccount"
      operationId: UnblockAccount
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSUnblockAccount200"
        "400":
          $ref: "#/components/responses/RSUnblockAccount400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/transactions":
    get:
      tags:
        - Accounts
      summary: Account Transactions
      description: >
        Allows your system to perform a query to retrieve the details of
        transactions for a specified customer and account for a client to
        visualize. The query returns all transactions, including those executed
        with a debit card. A general search can be filtered based on the
        direction of the transaction or a date range of transactions. You can
        optionally limit the maximum number of transactions to return.


        The query will return all relevant transaction details including transaction ID, date, amounts (separating taxes and fees), participating cards or accounts, and more.
      operationId: AccountTransactions
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountTransactions200"
        "400":
          $ref: "#/components/responses/RSAccountTransactions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    post:
      tags:
        - Accounts
      summary: Create Account To Account Transaction
      description: >
        Perform an internal-to-your-organization Account to Account
        transfer of funds. Sender specifies receiver’s account ID and transfer
        amount.
      requestBody:
        $ref: "#/components/requestBodies/RQAccountToAccountTransaction"
      operationId: CreateAccountToAccountTransaction
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSAccountToAccountTransaction200"
        "400":
          $ref: "#/components/responses/RSAccountToAccountTransaction400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/close":
    post:
      tags:
        - Accounts
      summary: Close Account
      description: >
        This operation allows to close an account previously created in the
        system.
      requestBody:
        $ref: "#/components/requestBodies/RQCloseAccount"
      operationId: CloseAccount
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
      responses:
        "200":
          $ref: "#/components/responses/RSCloseAccount200"
        "400":
          $ref: "#/components/responses/RSCloseAccount400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/transfers/{transferId}":
    get:
      tags:
        - Accounts
      summary: Transfer Details
      description: |
        This operation can be used to obtain details of a specific transaction.
      operationId: TransferDetails
      parameters:
        - $ref: "#/components/parameters/transferId"
      responses:
        "200":
          $ref: "#/components/responses/RSTransferDetails200"
        "400":
          $ref: "#/components/responses/RSTransferDetails400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/transactions":
    get:
      tags:
        - Accounts
      summary: Tenant Transactions
      description: |
        This operation can be used to list all the transactions for a tenant.
      operationId: TenantTransactions
      responses:
        "200":
          $ref: "#/components/responses/RSTenantTransactions200"
        "400":
          $ref: "#/components/responses/RSTenantTransactions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/associate":
    post:
      tags:
        - Novopayment Account Cards
      summary: Card To Account Association
      description: |
        Use this endpoint to link an unnamed card to an account.
      requestBody:
        $ref: "#/components/requestBodies/RQCardToAccountAssociation"
      operationId: CardToAccountAssociation
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      responses:
        "200":
          $ref: "#/components/responses/RSCardToAccountAssociation200"
        "400":
          $ref: "#/components/responses/RSCardToAccountAssociation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/disassociate":
    post:
      tags:
        - Novopayment Account Cards
      summary: Card To Account Disassociation
      description: |
        This endpoint serves the purpose of reversing the operation ***POST
        /customers/{customerId}/cards/{cardId}/associate*** linking the account to
        the card.

        It is designed to be used when the activation flow fails or when it is
        determined that the linking decision was incorrect. By utilizing this
        API, the previous association between the card and the linked account
        can be reversed.


        To ensure the proper functioning of this API, the following conditions must be met:

        - ***Anonymous Card:***
          The card in question must have been issued anonymously.
          This means that it does not contain any personally identifiable
          information (PII) of the cardholder.

        - ***No Associated Transactions:***
          The card should not have any associated transactions. This implies
          that no financial activities, such as purchases or payments, have
          been performed using the card.

        By meeting these conditions, the API can successfully reverse the
        decision regarding the linked account for the card. This functionality
        allows for rectifying any activation flow failures or incorrect linking
        decisions that may have occurred during the initial card setup process.
      requestBody:
        $ref: "#/components/requestBodies/RQCardToAccountDisassociation"
      operationId: CardToAccountDisassociation
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      responses:
        "200":
          $ref: "#/components/responses/RSCardToAccountDisassociation200"
        "400":
          $ref: "#/components/responses/RSCardToAccountDisassociation400"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/activate":
    put:
      tags:
        - Novopayment Account Cards
      summary: Card Activation
      description: |
        This operation allows the activation of a card.
      requestBody:
        $ref: "#/components/requestBodies/RQCardActivation"
      operationId: CardActivation
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      responses:
        "200":
          $ref: "#/components/responses/RSCardActivation200"
        "400":
          $ref: "#/components/responses/RSCardActivation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/emboss":
    post:
      tags:
        - Novopayment Account Cards
      summary: Card Embossing
      description: >
        This operation allows issuing a physical card of an existing
        virtual card.
      requestBody:
        $ref: "#/components/requestBodies/RQCardEmbossing"
      operationId: CardEmbossing
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      responses:
        "200":
          $ref: "#/components/responses/RSCardEmbossing200"
        "400":
          $ref: "#/components/responses/RSCardEmbossing400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/adjustments":
    post:
      tags:
        - Accounts
      summary: Credit Or Debit Adjustment
      description: >
        Allows an administrator to do a credit (+) or debit (-) adjustment
        to an account, specifying the amount and description of the transaction.
        In response, NovoPayment sends updated account balance information.
      requestBody:
        $ref: "#/components/requestBodies/RQAdjustments"
      operationId: Adjustments
      responses:
        "200":
          $ref: "#/components/responses/RSAdjustments200"
        "400":
          $ref: "#/components/responses/RSAdjustments400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/block":
    post:
      tags:
        - Novopayment Account Cards
      summary: Block Card
      description: |
        This operation allows to temporarily block the card.
      operationId: BlockCard
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      requestBody:
        $ref: "#/components/requestBodies/RQBlockCard"
      responses:
        "200":
          $ref: "#/components/responses/RSBlockCard200"
        "400":
          $ref: "#/components/responses/RSBlockCard400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards":
    post:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
      summary: Card Creation
      description: >
        Issue a virtual card for a specific customer and account. The card
        program must already be established using the Programs API.
      operationId: CardCreation
      requestBody:
        $ref: "#/components/requestBodies/RQCardCreation"
      responses:
        "200":
          $ref: "#/components/responses/RSCardCreation200"
        "400":
          $ref: "#/components/responses/RSCardCreation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}":
    get:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Card Detail
      description: |
        This operation allows to retrieve detailed information about a specific
        card.
      operationId: CardDetail
      responses:
        "200":
          $ref: "#/components/responses/RSCardDetail200"
        "400":
          $ref: "#/components/responses/RSCardDetail400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/pin":
    post:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Card PIN Assignment
      description: |
        This operation sets the card PIN.
      operationId: CardPINAssignment
      requestBody:
        $ref: "#/components/requestBodies/RQCardPINAssignment"
      responses:
        "200":
          $ref: "#/components/responses/RSCardPINAssignment200"
        "400":
          $ref: "#/components/responses/RSCardPINAssignment400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    put:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Card PIN Update
      description: This operation allows to update the current PIN of a specific card.
      operationId: CardPINUpdate
      requestBody:
        $ref: "#/components/requestBodies/RQCardPINUpdate"
      responses:
        "200":
          $ref: "#/components/responses/RSCardPINUpdate200"
        "400":
          $ref: "#/components/responses/RSCardPINUpdate400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/replacement":
    post:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Card Replacement
      description: |
        This operation allows to replace a card.
      operationId: CardReplacement
      requestBody:
        $ref: "#/components/requestBodies/RQCardReplacement"
      responses:
        "200":
          $ref: "#/components/responses/RSCardReplacement200"
        "400":
          $ref: "#/components/responses/RSCardReplacement400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/accounts/{accountId}/cards/{cardId}/securitcode":
    get:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/accountId"
        - $ref: "#/components/parameters/cardId"
      summary: Card Security Code CVV2
      description: |
        This operation allows to get the card security code CVV2.
      operationId: CardSecurityCodeCVV2
      responses:
        "200":
          $ref: "#/components/responses/RSCardSecurityCodeCVV2200"
        "400":
          $ref: "#/components/responses/RSCardSecurityCodeCVV2400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/transactions":
    get:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
        - $ref: "#/components/parameters/count"
        - $ref: "#/components/parameters/type"
        - $ref: "#/components/parameters/fromDate"
        - $ref: "#/components/parameters/toDate"
      summary: Card Transactions
      description: |
        This operation allows getting the transactions of a specific card.
      operationId: CardTransactions
      responses:
        "200":
          $ref: "#/components/responses/RSCardTransactions200"
        "400":
          $ref: "#/components/responses/RSCardTransactions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/operationlimits":
    put:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Customize Card Operations Limits
      description: >
        A user or administrator can establish more restrictive limits at an
        account level than those established by the card program. The Customize
        Card Operations Limits endpoint is used to place restrictions on the
        amount that can be spent with a card or the number of transactions that
        can be done with a card on a daily, weekly, or monthly basis as well as
        restrictions on the types of operations that can be performed with a
        card. This endpoint can be used to implement or update restrictions.
      operationId: CustomizeCardOperationsLimits
      requestBody:
        $ref: "#/components/requestBodies/RQCustomizeCardOperationsLimits"
      responses:
        "200":
          $ref: "#/components/responses/RSCustomizeCardOperationsLimits200"
        "400":
          $ref: "#/components/responses/RSCustomizeCardOperationsLimits400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/cards/{cardId}/unblock":
    post:
      tags:
        - Novopayment Account Cards
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/cardId"
      summary: Unblock Card
      description: |
        This operation allows to unblock a card.
      operationId: UnblockCard
      requestBody:
        $ref: "#/components/requestBodies/RQUnblockCard"
      responses:
        "200":
          $ref: "#/components/responses/RSUnblockCard200"
        "400":
          $ref: "#/components/responses/RSUnblockCard400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/cards/lookup":
    post:
      tags:
        - Novopayment Account Cards
      summary: Card Lookup
      description: |
        This API endpoint allows users to create batches of cards with ease.
        Users can customize each card with their own designs, logos, and text,
        and choose from a wide range of templates to get started. The API is
        designed to be fast, reliable, and secure, ensuring that data is always
        protected.


        We have different lookup types:

        - Activation code and the last four digits of the card.

        - Only with the card number.
      parameters:
        - in: query
          name: type
          required: true
          schema:
            $ref: "#/components/schemas/HeaderTypeParam"
      requestBody:
        $ref: "#/components/requestBodies/RQCardLookup"
      responses:
        "200":
          $ref: "#/components/responses/RSCardLookup200"
        "400":
          $ref: "#/components/responses/RSCardLookup400"
        "500":
          $ref: "#/components/responses/RS500"
  "/cards/anonymous/batches":
    post:
      tags:
        - Card Batch
      summary: Creation of Card Batches
      description: By using this endpoint, consumers can easily create batches of
        cards by providing the required information, such as the number of cards
        to be created, the card program, and the branch from the financial
        institution to link the set of cards. Once the information is entered,
        the system will initiate a scheduled process to issue and emboss the set
        of anonymous cards.
      requestBody:
        $ref: "#/components/requestBodies/RQCreationOfCardBatches"
      responses:
        "200":
          $ref: "#/components/responses/RSCreationOfCardBatches200"
        "400":
          $ref: "#/components/responses/RSCreationOfCardBatches400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    get:
      tags:
        - Card Batch
      parameters:
        - $ref: "#/components/parameters/fromDate"
        - $ref: "#/components/parameters/toDate"
        - $ref: "#/components/parameters/createdBy"
        - $ref: "#/components/parameters/statusId"
      summary: Card Batch List
      description: >
        The card batch information API allows users to retrieve a list of
        previously created batches of anonymous cards.


        This endpoint gives consumers data such as the batch ID, creation date, card quantity of each lot, and other relevant information for each batch.


        **The maximum range allowed for the query is 6 months, additionally if you do not send any field in the query, the system will retrieve the batches issued in the last 20 days.
      operationId: CardBatchList
      responses:
        "200":
          $ref: "#/components/responses/RSCardBatchList200"
        "400":
          $ref: "#/components/responses/RSCardBatchList400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/cards/anonymous/batches/{batchId}/status":
    put:
      tags:
        - Card Batch
      parameters:
        - $ref: "#/components/parameters/batchId"
      summary: Anonymous Card Batch Status Update
      description: >
        This API endpoint allows consumers to update or modify the status
        of a batch of cards that were previously created using the
        api/cards/anonymous/batch endpoint.


        A consumer might change the current status of a batch by indicating the batch ID, which identifies the specific batch of cards to be updated, and the new status of the batch.
      requestBody:
        $ref: "#/components/requestBodies/RQAnonymousCardBatchStatusUpdate"
      responses:
        "200":
          $ref: "#/components/responses/RSAnonymousCardBatchStatusUpdate200"
        "400":
          $ref: "#/components/responses/RSAnonymousCardBatchStatusUpdate400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/cards/anonymous/batches/{batchId}":
    get:
      tags:
        - Card Batch
      parameters:
        - $ref: "#/components/parameters/batchId"
      summary: Card Batch Info
      description: >
        This API endpoint allows the consumers to retrieve the details of a
        previously created batch of anonymous cards.
      operationId: CardBatchInfo
      responses:
        "200":
          $ref: "#/components/responses/RSCardBatchInfo200"
        "400":
          $ref: "#/components/responses/RSCardBatchInfo400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
security:
  - oAuth2ClientCredentials: []
components:
  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: {}
  examples:
    HeaderParamsRequired:
      value:
        code: 400.02.001
        message: Header Params Required
        datetime: "2020-01-03T16:05:56.517Z"
    RequestParamsRequired:
      value:
        code: 400.02.003
        message: Params required
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidAccessToken:
      value:
        code: 401.02.990
        message: Invalid Access Token
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenNotApproved:
      value:
        code: 401.02.991
        message: Access Token not approved
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidSignature:
      value:
        code: 401.02.992
        message: Invalid signature
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenExpired:
      value:
        code: 401.02.993
        message: Access token expired
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTenantId:
      value:
        code: 400.02.004
        message: Invalid tenant ID
        datetime: "2020-01-03T16:05:56.517Z"
    InternalServerError:
      value:
        code: 500.02.999
        message: Internal Server Error
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerNotFound:
      value:
        code: 400.02.382
        message: Customer not found
        datetime: "2020-01-03T16:05:56.517Z"
    CurrencyNotMatch:
      value:
        code: 400.02.490
        message: Currency not match
        datetime: "2020-01-03T16:05:56.517Z"
    AmountWasReached:
      value:
        code: 400.02.503
        message: The maximum amount of accounts per account program was reached
        datetime: "2020-01-03T16:05:56.517Z"
    ParameterFormatError:
      value:
        code: 400.02.081
        message: Parameter format error
        datetime: "2020-01-03T16:05:56.517Z"
    OFACRecordFound:
      value:
        code: 400.02.108
        message: OFAC record found
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedResourceNotFound:
      value:
        code: 400.02.022
        message: The requested resource was not found.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedResourceCouldNotFound:
      value:
        code: 400.02.022
        message: The requested resource could not be found. Please check your
          information and try again.
        datetime: "2020-01-03T16:05:56.517Z"
    ProcessNotCompleted:
      value:
        code: 400.02.019
        message: The process could not be completed.
        datetime: "2020-01-03T16:05:56.517Z"
    AccountNotExist:
      value:
        code: 400.02.070
        message: The requested account does not exist or does not belong to the
          customer. Please verify your information and try again.
        datetime: "2020-01-03T16:05:56.517Z"
    AccountIsBlocked:
      value:
        code: 400.02.406
        message: Account is blocked.
        datetime: "2020-01-03T16:05:56.517Z"
    AccountIsClosed:
      value:
        code: 400.02.410
        message: Account is closed.
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidData:
      value:
        code: 400.02.089
        message: Invalid data.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedProductNotExist:
      value:
        code: 400.02.068
        message: It is not possible to obtain information about the requested product.
        datetime: "2020-01-03T16:05:56.517Z"
    DatabaseError:
      value:
        code: 400.02.020
        message: Database result was ok, but it was not possible recognize data base
          response.
        datetime: "2020-01-03T16:05:56.517Z"
    GeneralError:
      value:
        code: 400.02.021
        message: Something unexpected has happened, please try again.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestAcknowledgeFa

# --- truncated at 32 KB (220 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/novopayment/refs/heads/main/openapi/novopayment-accounts-openapi.yml