NovoPayment Summary API

Transaction Summary

GitHub OpenAPI

Operations 1

POST /transactions/summary Transaction Summary #

Documentation

📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/payments/real-time-payments-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/payments/real-time-payments-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-summary-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-summary-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    name: API Support
    email: support@novopayment.com
    url: https://developer.novopayment.com/
  description: 'The Real-time payments API leverage the newest technologies to pull/push payments amongst VISA or MasterCard branded products such as debit, prepaid, and credit cards to manage transactions between individual banked consumers (P2P). All this developed with effective integrations and collaborations with relevant local and global payment networks and the domestic markets.


    Below operations are available for Real-Time Payments API:


    - Account to Account (AA): This operation is used to transfer to the same sender with different payment instruments. Both banks and non-banks can use it.

    - Person to Person: This operation is used to transfer funds when the sender and recipient are two different users.

    - Wallet Transfer: This operation is used to cash in a digital wallet from a Visa account.


    The operations available for the Real-time payments API are:


    - Money Transfer

    - Fund disbursement (Coming soon)'
  version: v1.0.0
  title: Real-Time Payments Summary API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/realtimepayments/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Summary
  description: Transaction Summary
paths:
  /transactions/summary:
    post:
      summary: Transaction Summary
      operationId: summary
      tags:
      - Summary
      description: shows the information of the transaction to be carried out
      requestBody:
        $ref: '#/components/requestBodies/RQTransactionSummary'
      responses:
        '200':
          $ref: '#/components/responses/RSTransactionSummary200'
        '400':
          $ref: '#/components/responses/RSSummary400'
        '401':
          $ref: '#/components/responses/RS401'
        '500':
          $ref: '#/components/responses/RS500'
        default:
          $ref: '#/components/responses/RS500'
components:
  schemas:
    RSGenericResponse:
      type: object
      additionalProperties: false
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          description: Operation response code
          minLength: 10
          maxLength: 10
          pattern: ^[0-9]{3}.[0-9]{2}.[0-9]{3}$
        message:
          type: string
          description: Response code description
          maxLength: 140
          minLength: 1
          pattern: '[a-zA-Z0-9:.,\s]{1,140}'
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
          maxLength: 29
        data:
          type: object
          additionalProperties: false
          properties:
            errors:
              type: array
              maxItems: 50
              items:
                type: object
                additionalProperties: false
                properties:
                  message:
                    type: string
                    description: Error Detail
                    maxLength: 300
                    pattern: ^[a-zA-Z0-9:.,\s]{1,300}$
    TransactionSummaryRequest:
      type: object
      additionalProperties: false
      required:
      - amount
      - sourceCurrency
      - destinationCurrency
      - transaction
      - surchargeInfo
      properties:
        amount:
          description: 'The amount of the transaction

            '
          type: number
          format: double
          example: 1000
          minimum: 1
          maximum: 9999999
        sourceCurrency:
          description: 'Source currency code. Use a 3-character alpha or numeric currency code for currency of the sender.

            '
          type: string
          example: INR
          maxLength: 3
          minLength: 3
        destinationCurrency:
          description: 'Destination currency code. Use a 3-character alpha or numeric currency code for currency of the recipient.

            '
          type: string
          example: INR
          maxLength: 3
          minLength: 3
        transaction:
          type: object
          additionalProperties: false
          required:
          - operationType
          - brandType
          - transactionCode
          properties:
            operationType:
              type: string
              description: type of operation (AFT, OCT, MONEY)
              example: OCT
              enum:
              - AFT
              - OCT
              - MONEY
            brandType:
              type: string
              description: Card brand type.
              example: VISA
              enum:
              - VISA
              - MASTERCARD
              - AMEX
            transactionCode:
              type: string
              description: 'Type of operation, Allowed values: 02: Person to Person (PP). 08: Account to Account (AA). 17(AFT)'
              example: 08
              enum:
              - '02'
              - 08
              - '17'
            applyTo:
              description: Indicates whether the conversion rate is to the destination or source currency.
              type: string
              example: SOURCE
        surchargeInfo:
          type: object
          additionalProperties: false
          required:
          - countrySender
          - countryRecipient
          properties:
            countrySender:
              description: country sender in alpha code
              type: string
              example: IND
              maxLength: 3
              minLength: 3
            countryRecipient:
              description: country recipient in alpha code
              type: string
              example: IND
              maxLength: 3
              minLength: 3
            surcharge:
              description: Is required when transaction.operationType is equal to OCT
              type: number
              format: double
              example: 5
              maximum: 9999999
    TransactionSummaryResponse:
      type: object
      additionalProperties: false
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 200.08.000
          description: Operation response code
          minLength: 10
          maxLength: 10
          pattern: ^[0-9]{3}.[0-9]{2}.[0-9]{3}$
        message:
          type: string
          example: Process Ok
          description: Response code description
          maxLength: 140
          minLength: 1
          pattern: '[a-zA-Z0-9:.\s]{1,140}'
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          description: Operation Time Stamp in ISO 8601 format
          format: date-time
          minLength: 1
          maxLength: 24
        data:
          $ref: '#/components/schemas/TransactionSummary'
    TransactionSummary:
      description: The transaction Detail
      type: object
      additionalProperties: false
      required:
      - destinationAmount
      - surcharge
      - markupRateApplied
      - totalWithFee
      - destionationCurrencyCode
      - sourceAmountWithoutMarkup
      - conversionRate
      properties:
        destinationAmount:
          type: string
          example: '216.7'
          description: Amount in destination currency.
          minLength: 1
        surcharge:
          type: string
          example: '100'
          description: The surcharge of the transaction
        markupRateApplied:
          type: string
          example: '2.0'
          description: Percentage of commission applied.
        totalWithFee:
          type: string
          example: '1200'
          description: Total amount with fee and surcharge
        destionationCurrencyCode:
          type: string
          example: ZAR
          description: currency code of the destination
        sourceAmountWithoutMarkup:
          type: string
          example: '980.39'
          description: Source amount whit mark up
        conversionRate:
          type: string
          example: '1.0'
          description: This is the conversion Rate.
    RS500:
      type: object
      additionalProperties: false
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 500.08.999
          description: Operation response code
          minLength: 10
          maxLength: 10
          pattern: ^[0-9]{3}.[0-9]{2}.[0-9]{3}$
        message:
          type: string
          example: Internal Server Error
          description: Response code description
          minLength: 1
          maxLength: 140
          pattern: '[a-zA-Z0-9:.\s]{1,140}'
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
          maxLength: 29
    RS401:
      type: object
      additionalProperties: false
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 401.08.990
          description: Operation response code
          minLength: 10
          maxLength: 10
          pattern: ^[0-9]{3}.[0-9]{2}.[0-9]{3}$
        message:
          type: string
          example: Invalid Access Token
          description: Response code description
          minLength: 1
          maxLength: 140
          pattern: '[a-zA-Z0-9:.\s]{1,140}'
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
          minLength: 1
          maxLength: 29
  examples:
    RQEndpointTransactionSummary:
      value:
        amount: 1000
        sourceCurrency: INR
        destinationCurrency: INR
        transaction:
          operationType: MONEY
          brandType: VISA
          transactionCode: 08
          applyTo: SOURCE
        surchargeInfo:
          countrySender: IND
          countryRecipient: IND
    InternalServerError:
      value:
        code: 500.08.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.08.992
        message: Invalid signature
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidAccessToken:
      value:
        code: 401.08.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
    AccessTokenExpired:
      value:
        code: 401.08.993
        message: Access token expired
        datetime: '2020-01-03T16:05:56.517Z'
    ParamsRequired:
      value:
        code: 400.08.003
        message: Params required
        datetime: '2020-01-03T16:05:56.517Z'
        data:
          errors:
          - message: if you want to search by rrn, the field stan is mandatory
    AccessTokenNotApproved:
      value:
        code: 401.08.991
        message: Access Token not approved
        datetime: '2020-01-03T16:05:56.517Z'
    RQEndpointTransactionSummaryFX:
      value:
        amount: 1000
        sourceCurrency: INR
        destinationCurrency: ZAR
        transaction:
          operationType: MONEY
          brandType: VISA
          transactionCode: 08
          applyTo: SOURCE
        surchargeInfo:
          countrySender: IND
          countryRecipient: ZAF
    InvalidParameters:
      value:
        code: 400.08.396
        message: Invalid parameters
        datetime: '2020-01-03T16:05:56.517Z'
        data:
          errors:
          - message: 'Field fielName: must not be blank'
  responses:
    RS401:
      description: Unauthorized (AP)
      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'
    RSSummary400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSGenericResponse'
          examples:
            Invalid Parameters:
              $ref: '#/components/examples/InvalidParameters'
            Params Required:
              $ref: '#/components/examples/ParamsRequired'
    RSTransactionSummary200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransactionSummaryResponse'
          examples:
            Transaction Summary FX:
              value:
                code: 200.08.000
                datetime: '2022-09-23T20:52:14.861Z'
                message: Process Ok
                data:
                  destinationAmount: '909.09'
                  surcharge: '100'
                  markupRateApplied: '10'
                  totalWithFee: '1100'
                  destionationCurrencyCode: ZAR
                  sourceAmountWithoutMarkup: '909.09'
                  conversionRate: '1.0'
            Transaction Summary Not FX:
              value:
                code: 200.08.000
                datetime: '2022-09-23T20:52:15.861Z'
                message: Process Ok
                data:
                  destinationAmount: '1000'
                  surcharge: '100'
                  markupRateApplied: '0'
                  totalWithFee: '1100'
                  destionationCurrencyCode: IND
                  sourceAmountWithoutMarkup: '1000'
                  conversionRate: '0'
    RS500:
      description: Internal Server Error (AP*)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerError'
  requestBodies:
    RQTransactionSummary:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransactionSummaryRequest'
          examples:
            Transaction Summary:
              $ref: '#/components/examples/RQEndpointTransactionSummary'
            Transaction Summary With FX:
              $ref: '#/components/examples/RQEndpointTransactionSummaryFX'
      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/realtime-payment-api/realtime-payment-api-v1.yml
  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)