Mastercard · Schema

Notification

notification request

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name	Type	Description
appId	string	Application identifier for client.
partnerId	string	Code to identify partner. Eg: school on Kupaa
providerReference	string	Unique transaction ID from Payment Provider
srcAccount	string	Payer mobile bank account number
paymentChannel	string	Depicts mode of payment as mentioned in enum.
transactionAmount	number	Transaction amount
accountId	string	Payer's account id
transactionDate	string	Transaction date in the format 'YYYY-MM-DD'
narration	string	Description of payment
accountName	string	Payer Name
accountNumber	string	Destination account number
currency	string	Alphabetic code of currency as per ISO4217 standard.
countryCode	string	ISO 3-alpha country code format.
signature	string	Signature for request
correlationId	string	CorrelationId for request

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Notification",
  "type": "object",
  "description": "notification request",
  "properties": {
    "appId": {
      "type": "string",
      "description": "Application identifier for client."
    },
    "partnerId": {
      "type": "string",
      "description": "Code to identify partner. Eg: school on Kupaa"
    },
    "providerReference": {
      "type": "string",
      "description": "Unique transaction ID from Payment Provider"
    },
    "srcAccount": {
      "type": "string",
      "description": "Payer mobile bank account number"
    },
    "paymentChannel": {
      "type": "string",
      "description": "Depicts mode of payment as mentioned in enum."
    },
    "transactionAmount": {
      "type": "number",
      "description": "Transaction amount"
    },
    "accountId": {
      "type": "string",
      "description": "Payer's account id"
    },
    "transactionDate": {
      "type": "string",
      "description": "Transaction date in the format 'YYYY-MM-DD'"
    },
    "narration": {
      "type": "string",
      "description": "Description of payment"
    },
    "accountName": {
      "type": "string",
      "description": "Payer Name"
    },
    "accountNumber": {
      "type": "string",
      "description": "Destination account number"
    },
    "currency": {
      "type": "string",
      "description": "Alphabetic code of currency as per ISO4217 standard."
    },
    "countryCode": {
      "type": "string",
      "description": "ISO 3-alpha country code format."
    },
    "signature": {
      "type": "string",
      "description": "Signature for request"
    },
    "correlationId": {
      "type": "string",
      "description": "CorrelationId for request"
    }
  }
}