Monoova Webhooks API

openapi: 3.2.0
info:
  title: Monoova Webhooks API
  contact:
    name: Monoova Support
    email: support@monoova.com
    url: https://www.monoova.com
  x-logo:
    url: https://movdpwebsiteprodae.blob.core.windows.net/images/Monoova-Primary-Logo-Black-RGB.png
    altText: Monoova logo
  version: '1.0'
  description: 'Operations tagged Webhooks across 3 of this provider''s published API definitions: monoova-cc.yml, monoova-payments.yml, monoova-payto.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.monoova.com
  description: Production URL#
- url: https://sand-api.monoova.com
  description: Sandbox URL
- url: https://api.mpay.com.au
  description: Production URL
- url: https://api.m-pay.com.au
  description: Sandbox URL
tags:
- name: Webhooks
  description: <p> In addition to callable reporting endpoints, webhooks will also be available for state changes for payment agreements and funds received. </p> </br></br>
paths:
  /WEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Payment Status Notification
      description: "<p>When the status of the payment changes, Monoova will send a webhook to notify the customer. Webhook will be triggered for the below statuses:</p>\n<ul>\n  <li>Failed</li>\n  <li>Declined</li>\n  <li>Settlement Complete</li>\n  <li>Cancelled</li>\n</ul>\n<p>Additionally, “interim” webhooks will be triggered when surcharging is in effect for the client, once the payment is authorised for a new client session. This is the point at which the surcharging information becomes available and can be communicated. In this scenario, the payment status could also be one of the following non-final status values:</p>\n<ul>\n  <li>Pending</li>\n  <li>Authorized</li>\n  <li>Settling</li>\n</ul>\n<p>Note that if the payment is made using a previously vaulted payment method, the surcharge is already known at new payment creation, so there is no additional interim webhook generated.</p>\n</br>\n<p>This webhook can be subscribed using APIs provided in <a href='/payTo#tag/Notification-Management'>Notification Management</a>.</p>\n</br>\n<p>Event name - <b>CreditCardPaymentNotification</b></p>\n"
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
        description: The securityToken from the subscription.
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGLjzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDnrz6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: 'This is a base64 encoded cryptographic signature that should be used<br/>

          to verify both the integrity of the message as well as the source (Monoova).<br/>

          The signature''s hashing method is SHA256 and the public key can be retrieved from

          <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key</a>.

          '
      operationId: PaymentStatusNotification
      security: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPaymentStatusResponseDto'
            example:
              eventId: 9E151397-BCA4-4700-8718-3907368780F5
              sourceEventName: CreditCardTransactionUpdated
              eventTimestamp: '2023-04-18T05:34:22.3447159Z'
              paymentDetails:
              - transactionId: '123456'
                settlementDateTime: '2023-04-19T05:34:14.5046065Z'
                settlementBatchId: batchId
                sessionCreationDateTime: '2023-04-18T05:34:14.5045854Z'
                clientTransactionUniqueReference: clientPaymentId1
                transactionInitiationDateTime: '2023-04-18T05:35:14.5045854Z'
                amount: '100.00'
                currencyCode: AUD
                surchargeAmount:
                  currencyAmount: '1.00'
                authenticationChallengeIssued: true
                authenticationResponseCode: AUTH_SUCCESS
                preAuthorizationFraudResult: THREE_DS
                postAuthorizationFraudResult: ACCEPT
                status: Settlement Complete
              - transactionId: '123456'
                settlementDateTime: '2023-04-19T05:34:14.504628Z'
                settlementBatchId: batchId
                sessionCreationDateTime: '2023-04-18T05:34:14.5046278Z'
                clientTransactionUniqueReference: clientPaymentId2
                transactionInitiationDateTime: '2023-04-18T05:35:14.5046278Z'
                amount: '100.00'
                currencyCode: AUD
                surchargeAmount:
                  currencyAmount: '1.50'
                authenticationChallengeIssued: true
                authenticationResponseCode: AUTH_SUCCESS
                preAuthorizationFraudResult: THREE_DS
                postAuthorizationFraudResult: ACCEPT
                status: Settlement Complete
              authenticationDetails:
                responseCode: AUTH_SUCCESS
                challengeIssued: true
              riskDetails:
                preAuthorizationResult: FAILED
                postAuthorizationResult: ACCEPT
      responses:
        '200':
          description: Any Response
    servers:
    - url: https://api.monoova.com
      description: Production URL#
    - url: https://sand-api.monoova.com
      description: Sandbox URL
  /WEBHOOK_REFUND_STATUS_URL:
    post:
      tags:
      - Webhooks
      summary: Refund Status Notification
      description: '<p> When the status of the refund changes, Monoova will send a webhook to notify the customer.  Webhook will be triggered for the below status </p> <ul> <li>Failed</li> <li>Declined</li> <li>Settlement Complete</li>

        </ul> </br> These webhook can be subscribed using API''s provided in <a href=''/payTo#tag/Notification-Management''>Notification Management</a>. </br> Event name - <b>CreditCardRefundNotification</b>'
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
        description: The securityToken from the subscription.
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      operationId: RefundStatusNotification
      security: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRefundStatusResponseDto'
            example:
              eventId: 9E151397-BCA4-4700-8718-3907368780F5
              sourceEventName: CreditCardRefundUpdated
              eventTimestamp: '2023-04-18T05:34:22.3447159Z'
              refundDetails:
              - transactionId: '123456'
                settlementDateTime: '2023-04-19T05:34:14.5046065Z'
                settlementBatchId: batchId
                sessionCreationDateTime: '2023-04-18T05:34:14.5045854Z'
                clientTransactionUniqueReference: clientPaymentId1
                transactionInitiationDateTime: '2023-04-18T05:35:14.5045854Z'
                amount: '100.00'
                currencyCode: AUD
                status: Settlement Complete
              - transactionId: '123456'
                settlementDateTime: '2023-04-19T05:34:14.504628Z'
                settlementBatchId: batchId
                sessionCreationDateTime: '2023-04-18T05:34:14.5046278Z'
                clientTransactionUniqueReference: clientPaymentId2
                transactionInitiationDateTime: '2023-04-18T05:35:14.5046278Z'
                amount: '100.00'
                currencyCode: AUD
                status: Settlement Complete
      responses:
        '200':
          description: Any Response
    servers:
    - url: https://api.monoova.com
      description: Production URL#
    - url: https://sand-api.monoova.com
      description: Sandbox URL
  /WEBHOOK_ASYNC_REQUEST_URL:
    post:
      tags:
      - Webhooks
      summary: Asynchronous Request Notification
      description: This webhook can be subscribed using API's provided in <a href='/payTo#tag/Notification-Management'>Notification Management</a>. </br> Event name - <b>AsyncJobResultNotification</b>
      operationId: AsyncRequestNotification
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
        description: The securityToken from the subscription.
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookAsyncRequestResponseDto'
            example:
              eventId: 9E151397-BCA4-4700-8718-3907368780F5
              sourceEventName: AsyncJobCompleted
              eventTimestamp: '2023-04-18T05:34:22.3447159Z'
              uniqueRequestId: b78e1829-dd2e-4119-a678-af8abccf9129
              status: Failed
              entityType: CreditCardPayment
              actionType: Create
              location: https://api.monoova.com/au/payto/pam/MONPAG2323232
              errorCode: PAM_UNEXPECTED_ERROR
              errorMessage: Internal server error. Please contact Monoova support.
      responses:
        '200':
          description: Any Response
    servers:
    - url: https://api.monoova.com
      description: Production URL#
    - url: https://sand-api.monoova.com
      description: Sandbox URL
  /RECEIVEPAYMENTWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Payment Webhook
      description: When an NPP payment is received, Monoova will send a callback with the below format. To subscribe to a webhook use the <a href="/payments#tag/Subscriptions"> Subscriptions </a> APIs. Event name:&nbsp;<strong>NPPReceivePayment</strong> <br/>
      operationId: ReceivablesReceivePaymentWebhook
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/event.receivePaymentWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /DIRECTDEBITCLEARANCEWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Direct Debit Clearance Webhook
      description: 'Receive a daily notification with a list of all direct debit transactions cleared on that day. To subscribe to this webhook, use the <a href="/payments#tag/Subscriptions">Subscriptions</a> APIs.

        Event name: <strong>DirectDebitClearance</strong>.

        <br/>

        '
      operationId: DirectDebitClearanceWebhook
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGLjzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDnrzZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message and its source (Monoova).<br/> The signature's hashing method is SHA256, and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey">/public/v1/certificate/public-key</a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/event.directDebitClearanceWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /PAYTORECEIVEPAYMENTWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Pay To Receive Payment Webhook
      description: When an NPP payment is received, Monoova will send a callback with the below format. To subscribe to a webhook use the <a href="/payments#tag/Subscriptions"> Subscriptions </a> APIs. Event name:&nbsp;<strong>PayToReceivePayment</strong> <br/>
      operationId: PayToReceivePaymentWebhook
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/event.payToreceivePaymentWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /INBOUNDDIRECTCREDITWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Inbound Direct Credits Webhook
      description: Subscribing to the direct credit event webhook will allow us to notify you when an inbound direct credit is received on one of your accounts. As direct credits arrive in batches, you will receive the data in an JSON array with multiple transactions multiple times per day. Event name:&nbsp;<strong>InboundDirectCredit</strong> <br/>
      operationId: InboundDirectCreditWebhook
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Receive Payment Web hook
              - $ref: '#/components/schemas/event.inboundDirectCreditWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /INBOUNDDIRECTDEBITWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Inbound Direct Debits  Webhook
      description: Subscribing to the direct debit event webhook will allow us to notify you when an inbound direct debit is received on one of your accounts. As direct debits arrive in batches, you will receive the data in an JSON array with multiple transactions multiple times per day. Event name:&nbsp;<strong>InboundDirectDebit</strong> <br/> <br/> Note:&nbsp; Source account details do not appear by default, please contact Monoova for further information <br/>
      operationId: InboundDirectDebitWebhook
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Receive Payment Web hook
              - $ref: '#/components/schemas/event.inboundDirectDebitWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /DIRECTENTRYDISHONOURSWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Direct Entry Dishonours Webhook
      description: Subscribing to the direct entry dishonours event webhook will allow us to notify you when an dishonour transaction is made. Event name:&nbsp;<strong>DirectEntryDishonour</strong> <br/>
      operationId: DirectEntryDishonour
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Receive Direct Entry Dishonours Web hook
              - $ref: '#/components/schemas/event.directEntryDishonoursWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /PENDINGRTGSIMTWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Pending Rtgs/Imt Webhook
      description: Subscribing to the Pending RTGS/IMT event webhook will allow us to notify you when a RTGS/IMT transaction is received on one of your accounts. As RTGS/IMT transaction arrive in batches, you will receive the data in an JSON array with multiple transactions multiple times per day. Event name:&nbsp;<strong>PendingInboundRtgsImt</strong> <br/>
      operationId: PendingInboundRtgsImt
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Inbound RTGS/Imt Web hook
              - $ref: '#/components/schemas/event.pendingrtgsImtWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /RTGSIMTWEBHOOKSTATUSWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Rtgs/Imt status Webhook
      description: Subscribing to the RTGS/IMT status event webhook will allow us to notify you when status of an RTGS/IMT transaction changes. Event name:&nbsp;<strong>InboundRtgsImtStatus</strong> <br/>
      operationId: InboundRtgsImtStatus
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Inbound RTGS/Imt Web hook
              - $ref: '#/components/schemas/event.InboundRtgsImtStatus'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /RECEIVENPPPAYMENTRETURNWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Npp Payment Return Webhook
      description: Subscribing to the npp return event webhook will allow us to notify you when an npp payment gets returned is made. Event name:&nbsp;<strong>NppReturn</strong> <br/>
      operationId: NppReturn
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Receive Npp Payment Return Web hook
              - $ref: '#/components/schemas/event.NppReturnWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /NPPPAYMENTSTATUSWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Receive Npp Payment Status Webhook
      description: Subscribing to the npp payment status event webhook will allow us to notify you when the status of a pending NPP Payment gets updated. Event name:&nbsp;<strong>NppPaymentStatus</strong> <br/> <strong>Note:&nbsp; </strong> Receive an NPP Payment Status Webhook notification when the status of an NPP payment changes so you don’t need to poll for updates. The "Pending" status is not reported by this webhook.<br/>
      operationId: NppPaymentStatus
      security: []
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        example: Bearer <TOKEN>
      - name: Verification-Signature
        in: header
        required: false
        schema:
          type: string
        example: e+AFAj2W69rAwbsGn+rSSnFm2ISEblo0MXnx9Qtoh2k5mst1cEEpcrVSzGL jzOPlEL2Ea/iYLbFGzDdxVRTcNLINOhsXM/smimNjBt8sq30FbvSNMjlfDn rZ6FOIkl3E3cu9B+M4OVL8HafPohb67IRNDNyCnCvBM10qHrioiak=
        description: This is a base64 encoded cryptographic signature that should be used<br/> to verify both the integrity of the message as well as the source (Monoova). <br/> The signature's hashing method is SHA256 and the public key can be retrieved from <a href="/payments#operation/PublicCertificatePublicKey"> /public/v1/certificate/public-key </a>.
      - name: Webhookid
        in: header
        required: false
        schema:
          type: integer
        description: Unique Id to identify this webhook notification.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - description: webhook
                title: Receive Npp Payment Status Webhook
              - $ref: '#/components/schemas/event.NppPaymentStatusWebhook'
      responses:
        '200':
          description: Is the expected response upon successful receipt. If any other status code response is received, we will retry one more time only, after a 30 second pause.
    servers:
    - url: https://api.mpay.com.au
      description: Production URL
    - url: https://api.m-pay.com.au
      description: Sandbox URL
  /INBOUNDDIRECTCREDITREJECTIONSWEBHOOK_TARGET_URL:
    post:
      tags:
      - Webhooks
      summary: Inbound Direct Credit Rejections Webhook
      description: Subscribing to the inbound direct credit rejection event webhook will allow us to notify you when an inbound direct credit intended for an ABA/PayId belonging to you is rejected because they didn't match any active reconciliation rule or the payer account was not included in your whitelist. As direct credits arrive in batches, you will receive the data in an JSON array with multiple transactions multiple times during the day. To subscribe to a webhook use the <a href="/payments#tag/Subscriptions"> Subscriptions </a> APIs. Event name:&nbsp; <strong> InboundDirectCreditRejections </strong> <br/>
      operationId: InboundDirectCreditRejections
      security: []
      parameters:
      - name: Authorization
        in: header
        required: fals

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