NovoPayment Real-Time Payments API

openapi: 3.0.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 API



tags:
  - name: Rtp-Send
    description: Rtp Send Money operations
  - name: Reverse
    description: Rtp reverse
  - name: Query
    description: Query Status Transaction
  - name: Summary
    description: Transaction Summary
 
    
servers:
  - description: Sandbox
    url: https://sandbox-api.novopayment.com/realtimepayments/v1
paths:
  /moneytransfer:
    post:
      summary: Money Transfer
      operationId: sendmoney
      tags:
        - Rtp-Send
      description: >
        Send funds to any Visa or Mastercard eligible card for domestic and
        cross-border transactions.


        The funds will be available within 30 minutes.
      requestBody:
        $ref: "#/components/requestBodies/RQMoneytransfer"
      responses:
        "200":
          $ref: "#/components/responses/RSMoneytransfer200"
        "400":
          $ref: "#/components/responses/RSMoneytransfer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $ref: "#/components/responses/RS500"

  /moneytransfer/transactions/adjustments/{transactionId}:
    post:
      summary: Reverse Adjustment
      operationId: adjustment
      tags:
        - Reverse
      description: |
        Execute a pull reverse manually without the 24-hour window.
      parameters:
        - in: path
          name: transactionId # Note the name is the same as in the path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 40
            pattern: ^[A-Za-z0-9-]+$
          description: The transaction identificator
          example: 87b42ea2-2db6-4dab-a5b4-11a41f373179
      requestBody:
        $ref: "#/components/requestBodies/RQReverseAdjustment"
      responses:
        "200":
          $ref: "#/components/responses/RSReverseAdjustment200"
        "400":
          $ref: "#/components/responses/RSReverseAdjustment400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $ref: "#/components/responses/RS500"
  /moneytransfer/transactions/funds/pull:
    post:
      summary: Pull Funds
      operationId: pull
      tags:
        - Rtp-Send
      description: >
        Pull Transfer, withdraw funds from a sender's card to later send
        them to a recipient's card.
      requestBody:
        $ref: "#/components/requestBodies/RQPullFunds"
      responses:
        "200":
          $ref: "#/components/responses/RSPullFunds200"
        "400":
          $ref: "#/components/responses/RSPullTransfer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $ref: "#/components/responses/RS500"
  /moneytransfer/transactions/funds/push:
    post:
      summary: Push Funds
      operationId: push
      tags:
        - Rtp-Send
      description: |
        Push Transfer, adds resources to a recipient's account.
      requestBody:
        $ref: "#/components/requestBodies/RQPushFunds"
      responses:
        "200":
          $ref: "#/components/responses/RSPushFunds200"
        "400":
          $ref: "#/components/responses/RSPushFunds400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $ref: "#/components/responses/RS500"
  /moneytransfer/transactions/funds/reverse/{transactionId}:
    post:
      tags:
        - Reverse
      summary: Reverse Funds
      operationId: reverse
      description: |
        Execute the reverse of a pull transfer transaction
      parameters:
        - in: path
          name: transactionId # Note the name is the same as in the path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 40
            pattern: ^[A-Za-z0-9-]+$
          description: The transaction Identificator
          example: c3c90deb537246ea8689ed6f5a9a3d23

      responses:
        "200":
          $ref: "#/components/responses/RSReverseFunds200"
        "400":
          $ref: "#/components/responses/RSReverseFunds400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $ref: "#/components/responses/RS500"
  /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"
  /query/transactions:
    get:
      summary: Query Transaction 
      operationId: query
      tags:
        - Query
      description: |
        Get transactions by the reference (**tr**) or by transaction identifiers (**stan** and **rrn**)
      parameters:
        - in: query
          name: tr 
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 40
            pattern: ^[A-Za-z0-9]{40}$
          description: |
            **transactionReferece** (tr) used to relate to a financial transaction.
          example: c3c90deb537246ea8689ed6f5a9a3d2322ac23gs
        - in: query
          name: stan
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 6
            pattern: ^[\d]{6}$
          description: |
            The **systemTraceAuditNumber** (stan) for the transaction.
            (**This parameter is mandatory if retrievalReferenceNumber is present**)
          example: "350420"
          x-suggested:
            description: |
              The retrieval Reference Number for the transaction. 
              This parameter is mandatory if retrievalReferenceNumber is present.
        - in: query
          name: rrn
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 12
            pattern: ^[\d]{12}$
          description: |
            The **retrievalReferenceNumber** (rrn) for the transaction. 
            (**This parameter is mandatory if systemsTraceAuditNumber is present**)
          x-suggested:
            description: |
              The retrieval Reference Number for the transaction. 
              This parameter is mandatory if systemsTraceAuditNumber is present.
          example: "401010350420"

      responses:
        "200":
          $ref: "#/components/responses/RSQuery200"
        "400":
          $ref: "#/components/responses/RSQuery400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
        default:
          $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:
    RQRecipientWithAlias:
      value:
        domesticTransaction: true
        transactionCode: "02"
        transactionReference: "4498567a-ace5-4498-b382-a1c0038c4aa0"
        sender:
          aliasDirectory: true
          aliasId: 5d1bf399902e42f79681c5be8dfdcb02
          paymentInstrumentId: 87f1467d40154354a8f6d5ec83005626
        recipient:
          aliasDirectory: true
          aliasType: EMAIL
          alias: jhondoe@gmail.com
        transactionAmount:
          senderAmount: 10000
          sourceCurrencyCode: "USD"
          surcharge: 2.2
          purpose: "Domestic Funds Transfer"
    RQRecipientWithoutAlias:
      value:
        domesticTransaction: true
        transactionCode: "02"
        sender:
          aliasDirectory: true
          aliasId: 5d1bf399902e42f79681c5be8dfdcb02
          paymentInstrumentId: 87f1467d40154354a8f6d5ec83005626
        recipient:
          aliasDirectory: false
          paymentInformation:
            cardToken: 40IsnNA9r2s0XTvsqYqkYBwFKVbEzE7f3CijGRfI2Ss=
            cardHolder:
              firstName: Jane
              lastName: Doe
              documentType:
                code: "GOVERNMENT_ID"
              documentNumber: "12345678"
              email: janedoe@example.com
              address:
                line1: 123 Main st
                line2: Apt 2002
                city: Austin
                state: TX
                postalCode: "78759"
                country: USA
        transactionAmount:
          senderAmount: 10000
          sourceCurrencyCode: USD
          surcharge: 2.2
          purpose: Funds Transfer Domestic
        transactionReference: 9a081ed0-3f3d-11eb-b378-0242ac130002

    RQEndpointReverseAdjustment:
      value:
        adjustmentTransactionCode: "12"
        amount: 10000
        currencyCode: "USA"
        surcharge: 200
        transactionCode: "02"
    RQEndpointPullFundsAlias:
      value:
        domesticTransaction: true
        transactionCode: "02"
        transactionReference: "34081ed0-3f3d-11eb-b378-0242ac130002"
        sender:
          aliasDirectory: true
          aliasId: 5d1bf399902e42f79681c5be8dfdcb02
          paymentInstrumentId: "12345678901234567890123456789012"
        recipient:
          aliasDirectory: true
          alias: noalias@gmial.com
          aliasType: EMAIL

        transactionAmount:
          senderAmount: 230
          sourceCurrencyCode: USD
          purpose: "rent"
          surcharge: 260

    RQEndpointPullFunds:
      value:
        domesticTransaction: true
        transactionCode: "02"
        transactionReference: "4498567a-ace5-4498-b382-a1c0038c4aa0"
        sender:
          aliasDirectory: false
          paymentInstrumentId: "12345678901234567890123456789012"
          paymentInformation:
            cardToken: Hs3xlaAXURkx+K1yF5nk9w04rZnC3BS17wh/qe+m+lQ=
            cvvNumber: Hs3xlaAXURkx+K1yERTTYUIO
            cardHolder:
              documentNumber: "124315643"
              documentType:
                code: GOVERNMENT_ID
              firstName: Juan
              lastName: Santos
              address:
                line1: calle 34
                line2: white house
                city: miami
                country: USA
                postalCode: "12345"
                state: FL

        recipient:
          aliasDirectory: false
          alias: noalias@gmial.com
          aliasType: EMAIL
          paymentInformation:
            cardToken: Hs3xlaAXURkx+K1yF5nk9w04rZnC3BS17wh/qe+m+lQ=
            cardHolder:
              documentNumber: "124315643"
              documentType:
                code: GOVERNMENT_ID
              firstName: Adriana
              lastName: Perez
              address:
                line1: calle 90
                line2: white house
                city: miami
                country: USA
                state: FL
                postalCode: "12345"
        transactionAmount:
            senderAmount: 230
            sourceCurrencyCode: USD
            purpose: "rent"
            surcharge: 260

    RQEndpointPushFundsSenderAliasRecipientNotAlias:
      value:
        transactionCode: "17"
        domesticTransaction: true
        transactionReference: 4498567a-ace5-4498-b382-a1c0038c4aa0
        sender:
          aliasDirectory: true
          aliasId: 5d1bf399902e42f79681c5be8dfdcb02
          paymentInstrumentId: 0035253fce61485d8ffa5caf42f42ccf
        recipient:
          aliasDirectory: false
          paymentInformation:
            cardToken: VPEEIIsMLff5b+uwX2rwexWuS+vAtSWm4ZjlYNKeK84=
            cardHolder:
              firstName: Deborah
              lastName: White
              documentType: 
                code: GOVERNMENT_ID
              documentNumber: "12345678"
              email: deborahWhite@mail.com
              address:
                line1: 123 Main st
                line2: Apt 2002
                city: Austin
                state: TX
                postalCode: "78759"
                country: USA

        transactionAmount:
          senderAmount: 1000
          sourceCurrencyCode: "356"
          destinationCurrencyCode: "356"
          surcharge: 300
          purpose: Funds Transfer
    RQEndpointPushFundsNotAlias:
      value:
        transactionCode: "17"
        domesticTransaction: true
        transactionReference: 4498567a-ace5-4498-b382-a1c0038c4aa0
        sender:
          aliasDirectory: false
          paymentInformation:
            cardToken: fRuh9leWqJgc8shMb56hZy3QnBUjH4fCw48FHySR9QE=
            cardHolder:
              firstName: junior
              lastName: White
              documentType: 
                code: GOVERNMENT_ID
              documentNumber: "13245678"
              email: junior@mail.com
              address:
                line1: 321 Main st
                line2: Apt 2222
                city: Austin
                state: TX
                postalCode: "78759"
                country: INR
    
        recipient:
          aliasDirectory: false
          paymentInformation:
            cardToken: VPEEIIsMLff5b+uwX2rwexWuS+vAtSWm4ZjlYNKeK84=
            cardHolder:
              firstName: Deborah
              lastName: White
              documentType: 
                code: GOVERNMENT_ID
              documentNumber: "12345678"
              email: deborahWhite@mail.com
              address:
                line1: 123 Main st
                line2: Apt 2002
                city: Austin
                state: TX
                postalCode: "78759"
                country: USA
               
               
        transactionAmount:
          senderAmount: 1000
          sourceCurrencyCode: "356"
          destinationCurrencyCode: "356"
          surcharge: 300
          purpose: Funds Transfer
    RQEndpointPushFundsRecipientWithAlias:
      value:
        transactionCode: "17"
        domesticTransaction: true
        transactionReference: 4498567a-ace5-4498-b382-a1c0038c4aa0
        sender:
          aliasDirectory: false
          paymentInformation:
            cardToken: fRuh9leWqJgc8shMb56hZy3QnBUjH4fCw48FHySR9QE=
            cardHolder:
              firstName: junior
              lastName: White
              documentType: 
                code: GOVERNMENT_ID
              documentNumber: "13245678"
              email: junior@mail.com
              address:
                line1: 321 Main st
                line2: Apt 2222
                city: Austin
                state: TX
                postalCode: "78759"
                country: INR
               
        recipient:
          aliasDirectory: true
          alias: junioSender@gmail.com
          aliasType: EMAIL
          
        transactionAmount:
          senderAmount: 1000
          sourceCurrencyCode: "356"
          destinationCurrencyCode: "356"
          surcharge: 300
          purpose: Funds Transfer
    RQEndpointPushFundsSenderAndRecipientAlias:
      value:
        transactionCode: "17"
        domesticTransaction: true
        transactionReference: 4498567a-ace5-4498-b382-a1c0038c4aa0
        sender:
          aliasDirectory: true
          aliasId: 5d1bf399902e42f79681c5be8dfdcb02
          paymentInstrumentId: 8d24929d0981421395fc02b9591474c4
        recipient:
          aliasDirectory: true
          alias: junioSender@gmail.com
          aliasType: EMAIL
        transactionAmount:
          senderAmount: 1000
          sourceCurrencyCode: "356"
          destinationCurrencyCode: "356"
          surcharge: 300
          purpose: Funds Transfer
    RQEndpointTransactionSummary:
      value:
        amount: 1000
        sourceCurrency: "INR"
        destinationCurrency: "INR"
        transaction:
          operationType: "MONEY"
          brandType: "VISA"
          transactionCode: "08"
          applyTo: "SOURCE"
        surchargeInfo:
          countrySender: "IND"
          countryRecipient: "IND"
          
    RQEndpointTransactionSummaryFX:
      value:
        amount: 1000
        sourceCurrency: "INR"
        destinationCurrency: "ZAR"
        transaction:
          operationType: "MONEY"
          brandType: "VISA"
          transactionCode: "08"
          applyTo: "SOURCE"
        surchargeInfo:
          countrySender: "IND"
          countryRecipient: "ZAF"
        
    JweInvalidFormat:
      value:
        code: 400.08.002
        message: JWE Invalid format
        datetime: "2020-01-03T16:05:56.517Z"
    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"
    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"
    CardNotAllowed:
      value:
        code: 400.08.101
        message: Card not allowed
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTrCode:
      value:
        code: 400.08.338
        message: Invalid transaction code
        datetime: "2020-01-03T16:05:56.517Z"
    InsufficientFunds:
      value:
        code: 400.08.044
        message: Insufficient funds
        datetime: "2020-01-03T16:05:56.517Z"
    ExceedsLimitDaily:
      value:
        code: 400.08.041
        message: Exceeds the limit amount of daily operations
        datetime: "2020-01-03T16:05:56.517Z"
    ExceedsLimitWeekly:
      value:
        code: 400.08.042
        message: Exceeds the limit amount of weekly operations
        datetime: "2020-01-03T16:05:56.517Z"
    ExceedsLimitMontly:
      value:
        code: 400.08.043
        message: Exceeds the limit amount of monthly operations
        datetime: "2020-01-03T16:05:56.517Z"  
    ExceedsCountDaily:
      value:
        code: 400.08.038
        message: Exceeds the limit count of daily operations. The number of daily transactions for this account has been reached
        datetime: "2020-01-03T16:05:56.517Z"   
    ExceedsCountWeekly:
      value:
        code: 400.08.039
        message: The number of weekly transactions for this account has been reached
        datetime: "2020-01-03T16:05:56.517Z"
    ExceedsCountMontly:
      value:
        code: 400.08.040
        message: The number of monthly transactions for this account has been reached
        datetime: "2020-01-03T16:05:56.517Z"
    PIVerification:
      value:
        code: 400.08.504
        message: Payment instrument in verification
        datetime: "2020-01-03T16:05:56.517Z"
    PIFailed:
      value:
        code: 400.08.505
        message: Failed verification of payment instrument
        datetime: "2020-01-03T16:05:56.517Z"
    BankCustomerNotAvailable:
      value:
        code: 400.08.301
        message: Bank Customer Service not available
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerProblems:
      value:
        code: 400.08.391
        message: The customer reported problems in this transaction.
        datetime: "2020-01-03T16:05:56.517Z"
    CardSecurityCode:
      value:
        code: 400.08.049
        message: Card security code is invalid
        datetime: "2020-01-03T16:05:56.517Z"
    TransactionCancelled:
      value:
        code: 400.08.340
        message: Transaction already cancelled 
        datetime: "2020-01-03T16:05:56.517Z"
    DomesticTrNoSupported:
      value:
        code: 400.08.501
        message: Domestic transactions not supported
        datetime: "2020-01-03T16:05:56.517Z"
    CrossBorderTrNoSupported:
      value:
        code: 400.08.500
        message: Cross border transactions not supported
        datetime: "2020-01-03T16:05:56.517Z"
        
    InvalidMerchant:
      value:
        code: 400.08.510
        message: Invalid merchant.
        datetime: "2020-01-03T16:05:56.517Z"

    FraudFree:
      value:
        code: 400.08.511
        message: Fraud free pick up card.
        datetime: "2020-01-03T16:05:56.517Z" 

    PickUpCard:
      value:
        code: 400.08.512
        message: Pick up card, special condition, fraud account.
        datetime: "2020-01-03T16:05:56.517Z" 

    NoSuchIssuer:
      value:
        code: 400.08.513
        message: No such issuer.
        datetime: "2020-01-03T16:05:56.517Z" 

    NoCreditAccount:
      value:
        code: 400.08.514
        message: No credit account.
        datetime: "2020-01-03T16:05:56.517Z" 
    
    LostCard:
      value:
        code: 400.08.515
        message: Lost card, pick up, fraud account.
        datetime: "2020-01-03T16:05:56.517Z" 

    StolenCard:
      value:
        code: 400.08.516
        message: Stolen card, pick up (fraud account)..
        datetime: "2020-01-03T16:05:56.517Z" 

    NoCheckingAccount:
      value:
        code: 400.08.517
        message: No checking account.
        datetime: "2020-01-03T16:05:56.517Z" 
    
    NoSavingsAccount:
      value:
        code: 400.08.518
        message: No savings account.
        datetime: "2020-01-03T16:05:56.517Z" 

    TransactionNotCardholder:
      value:
        code: 400.08.519
        message: Transaction not permitted to cardholder.
        datetime: "2020-01-03T16:05:56.517Z" 

    SuspectedFraud:
      value:
        code: 400.08.520
        message: Suspected fraud.
        datetime: "2020-01-03T16:05:56.517Z" 
    
    SourceNotCorrect:
      value:
        code: 400.08.521
        message: Source is not correct issuer.
        datetime: "2020-01-03T16:05:56.517Z"
    
    ExceedsWithdrawal:
      value:
        code: 400.08.522
        message: Exceeds withdrawal frequency limit.
        datetime: "2020-01-03T16:05:56.517Z"

    AlreadyReversed:
      value:
        code: 400.08.523
        message: Already reversed by Switch.
        datetime: "2020-01-03T16:05:56.517Z"

    TransactionCannotCompleted:
      value:
        code: 400.08.524
        message: Transaction cannot be completed.
        datetime: "2020-01-03T16:05:56.517Z"
    
    AdditionalCustomer:
      value:
        code: 400.08.525
        message: Additional customer authentication required.
        datetime: "2020-01-03T16:05:56.517Z"

    CashExceedsLimit:
      value:
        code: 400.08.526
        message: Cash request exceeds issuer or approved limit.
        datetime: "2020-01-03T16:05:56.517Z"

    TransactionAmountExceeds:
      value:
        code: 400.08.527
        message: Transaction amount exceeds preauthorized approval amount.
        datetime: "2020-01-03T16:05:56.517Z"
    
    CardAuthenticationFailed:
      value:
        code: 400.08.528
        message: Card Authentication failed.
        datetime: "2020-01-03T16:05:56.517Z"

    StopPaymentOrder:
      value:
        code: 400.08.529
        message: Stop Payment Order.
        datetime: "2020-01-03T16:05:56.517Z"

    HeaderParamsRequired:
      value:
        code: 400.08.001
        message: Header Params Required
        datetime: "2020-01-03T16:05:56.517Z"
    DataNotAvailable:
      value:
        code: 400.08.052
        message: Data not available, please try again
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidEncryptedData:
      value:
        code: 400.08.320
        message: Invalid Encrypted Data
        datetime: "2020-01-03T16:05:56.517Z"
    CurrencyNotSupported:
      value:
        code: 400.08.339
        message: Currency not supported
        datetime: "2020-01-03T16:05:56.517Z"
    TransactionNotProcessed:
      value:
        code: 400.08.801
        message: The transaction has not been processed due to problems in the validation of the business.
        datetime: "2020-01-03T16:05:56.517Z"
    SenderCardInactive:
      value:
        code: 400.08.435
        message: Sender card is inactive
        datetime: "2020-01-03T16:05:56.517Z"
    TransactionCanceled:
      value:
        code: 400.08.340
        message: Transaction already cancelled
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTransactionCode:
      value:
        code: 400.08.338
        message: Invalid transaction code
        datetime: "2020-01-03T16:05:56.517Z"

    CardSecurityCodeInvalid:
      value:
        code: 400.08.049
        message: Card security code is invalid 
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidAlias:
      value:
        code: 400.08.102
        message: Invalid Alias 
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidCardInformation:
      value:
        code: 400.08.046
        message: The payment could not be processed because of invalid card information 
        datetime: "2020-01-03T16:05:56.517Z"
    ComponentConfigurationNotFound:
      value:
        code: 400.08.356
        message: Component configuration not found.
        datetime: "2020-01-03T16:05:56.517Z"
    SenderComplianceList:
      value:
        code: 400.08.434
        message: Sender has hits in compliance lists
        datetime: "2020-01-03T16:05:56.517Z"
    RecipientComplianceList:
      value:
        code: 400.08.431
        message: Recipient has hits in compliance lists
        datetime: "2020-01-03T16:05:56.517Z"
    TransactionNotFound:
      value:
        code: 400.08.110
        message: Transaction not found
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTransactionType:
      value:
        code: 400.08.361
        message: Invalid transaction type
        datetime: "2020-01-03T16:05:56.517Z"   
    TransactionRejected:
      value:
        code: 400.08.505
        message: Transaction rejected
        datetime: "2020-01-03T16:05:56.517Z"  
    UnableToReverseTransaction:
      value:
        code: 400.08.441
        message: Unable to reverse transaction
        datetime: "2020-01-03T16:05:56.517Z"                                
    InvalidTenantId :
      value:
        code: 400.08.004
        message: Invalid Tenant ID
        datetime: "2020-01-03T16:05:56.517Z" 
    UnableProcessRequest :
      value:
        code: 400.08.105
        message: Unable process request
        datetime: "2020-01-03T16:05:56.517Z"               
    InvalidAccessToken:
      value:
        code: 401.08.990
        message: Invalid Access Token
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenNotApproved:
      value:
        code: 401.08.991
        message: Access Token not approved
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidSignature:
      value:
        code: 401.08.992
        message: Invalid signature
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenExpired:
      value:
        code: 401.08.993
        message: Access token expired
        datetime: "2020-01-03T16:05:56.517Z"
    InternalServerError:
      value:
        code: 500.08.001
        message: Internal Server Error
        datetime: "2020-01-03T16:05:56.517Z"
  schemas:

    MoneyTransferRequest:
      type: object
      additionalProperties: false
      required:
        - transactionCode
        - sender
        - recipient
        - transactionAmount
        - transactionReference
      properties:
        domesticTransaction:
          type: boolean
          description: |
            __Allowed values:__
            __true__ (Domestic Transaction)
            __false__ (Cross-border Transaction)
            Transaction is Domestic or Cross-border. 
            boolean represents two values: true and false. Note: that truthy and falsy values such as "true", "", 0 or null are not considered boolean values
          example: true
        transactionCode:
          type: string
          description: |
            Type of operation, Allowed values: 02: Person to Person (PP). 08:
            Account to Account (AA).
          example: '02'
          pattern: 02|08
          enum:
            - '02'
            - '08'
          maxLength: 2
          minLength: 2

        transactionReference:
          type: string
          description: |
            A value used to related to a financial transaction (**this field should be unique**)
          example: "9a081ed0-3f3d-11eb-b37"
          minLength: 1
          maxLength: 40
          pattern: ^[A-Za-z0-9-]+$
        sender:
          $ref: "#/components/schemas/Sender"

        recipient:
          $ref: "#/components/schemas/Recipient"

        transactionAmount:
          $ref: "#/components/schemas/TransactionAmount"

    ReverseTransactionsRequest:
      type: object
      additionalProperties: false
      description: |
        Represents the data to Request Adjustment Reverse
      required:
        - adjustmentTransactionCode
        - amount
        - currencyCode
        - transactionCode
      properties:
        adjustmentTransactionCode:
          type: string
          description: |
            Type of transaction to be adjusted. 11 Debit Adjustment, 12 Credit Adjustment
          example: "12"
          pattern: 11|12
          enum:
            - "11"
            - "12"
          maxLength: 2
          minLength: 2

        amount:
          type: number
          format: decimal
          description: |
            Total transaction amount, including all transactions fee
          example: 10000
          minimum: 1
          maximum: 999999999
          exclusiveMinimum: false
          exclusiveMaximum: false

        currencyCode:
          type: string
          description: |
            Use a 3-character alpha currency code.
            __Refer to:__ [ISO Currency Codes](https://developer.novopayment.com/api/request-and-response-codes#item-isocurrencycodes)
          example: "USA"
          pattern: "[A-Z]{3}"
          maxLength: 3
          minLength: 3
        surcharge:
          type: number
          format: decimal
          description: |
            Operation fee or surcharge. This field must be in the same currency and format of the amount.
          example: 200
          minimum: 0
          maximum: 999999999
          exclusiveMinimum: false
          exclusiveMaximum: false

        transactionCode:
          type: string
          description: |
            Transaction code of the original transaction to be reversed, 02 Person to Person (PP),08 Account to Account (AA) ,17(FT) 
          example: "02"
          pattern: 02|08|17
          enum:
            - "02"
            - "08"
            - "17"
          maxLength: 2
          minLength: 2

    PullFundsRequest:
      type: object
      additionalProperties: false
      required: 
        - domesticTransaction
        - sender
        - transactionAmount
        - recipient
        - transactionCode
        - transactionReference
      properties:
        domesticTransaction:
          type: boolean
          description: |
            __Allowed values:__
            __true__ (Domestic Transaction)
            __false__ (Cross-border Transaction)
            Transactio

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