Program Specific Notifications

{
  "uniqueReference": "{unique reference of the transaction being settled}",
  "notificationType": "Settlement"
}

{
    "uniqueReference": "{unique reference of the transaction being refunded}",
    "refundedTransactionReferences": [ "{array of transaction references of dependent transactions being refunded}" ],
    "refundTransactionReference": "{unique reference of the refund transaction}",
    "refundingTransactionReferences": [ "{array of transaction references of the dependent refunding transactions}" ],
    "notificationType": "Refund"
}

{
    "uniqueReference": "{unique reference of the transaction being charged back}",
    "chargedBackTransactionReferences": [ "{array of transaction references of dependent transactions being charged back}" ],
    "chargebackTransactionReference": "{unique reference of the chargeback transaction}",
    "chargingBackTransactionReferences": [ "{array of transaction references of the dependent chargeback transactions}" ],
    "amount": 12.34,
    "chargebackReason": {
        "code": "123",
        "description": "Example Reason for Chargeback"
    },
    "notificationType": "Chargeback"
}

{
"notificationType": "MerchantOnboardingCompleted",
"programName": "{Name of the Program owning the Merchant}",
"programCode": "{Code of the Program owning the Merchant}",
"merchantName": "{Name of the Merchant that is On-boarding}",
"merchantReference": "{Unique Reference of the Merchant}",
"merchantStatus": "Completed"
}

{
"notificationType": "AccountStatusChange",
"accno": "{account number of the affected account}",
"externalAccountReference": "{external account reference of the affected account}",
"newStatus": "{status code of the new account status}"
}

{
  "notificationType": "DebtorInvoiceCallback",
  
  "id": "{Unique Invoice Identifier in the Debtor Management}",
  "customerId": "{Identifier of the Customer / Payer Account}",
  "created": "{Created Time, Format YYYY-MM-DD[T]HH:mm:ss[Z]}",
  "documentType": "{Type of Invoice, ex. Invoice, Memo, etc.}",
  "status": "{Status of the Invoice in the Debtor Management}",
  
  "items": // The "items" Array can contain Multiple Orders
  [{
    "itemId": "{Unique Identifier of the Order / Payment}",
    
    "applicationItems": // Can contain Multiple Order Items
    [{
      "number": "{Identifier of the Order Position Number / Item}",
      "totalAmountInclusiveVat": {Gross Price of the Order Item},
      "totalAmountExclusiveVat": {Net Price of the Order Item},
      "outstanding": {Amount Still Pending Payment for Item},
      "status": {Status of Order Item in Debtor Management}
    }]
  }],
  
  "totalAmountInclusiveVat": {Gross Amount of the Entire Invoice},
  "totalAmountExclusiveVat": {Net Amount of the Entire Invoice},
  "totalAmountVat": {The Full VAT Amount of the Entire Invoice},
  "totalOutstanding": {Full Amount Pending Payment of Invoice}
}

{
  "notificationType": "DebtorErrorCallback",

  "error": "{Error Description forwarded from Debtor Management Provider}",

  "itemIdentifier": {
    "itemType": "{Designates the Entity Type of the Following 'itemId'}",
    "itemId": "{Unique ID of User / Transaction / Order having an Error}",
    "relatedOrderId": "{Optional, Only if Error is Related to an Order}",
    "clientId": "{Identifier of Client's Debtor Management Environment}",
    "division": "{Either 'USR' for B2C Booking or 'BIZ' for B2B Booking}"
  }
}

{
"notificationType": "ComplianceCallback",
"archiveId": "{'ArchiveId' specified in the compliance check record}",
"decision": "{'ManualReviewResult' specified in the compliance check record: 1 -> 'OK', 0 -> 'KO'}",
"comment": "{'ReviewComment' specified in the compliance check record}"
}

{
  "notificationType": "PaymentOptionAdded",
  "storedPaymentOptionReference": "{Unique Reference of the Stored Payment Option}",
  "validUntil": "{Validity Date of the Stored Payment Option, format 'YYYY-MM-DD'}",
  "accno": "{Account Number to which the above Stored Payment Option belongs to}",
  "externalAccountReference": "{External Account Reference of the above Account}"
}

{
"notificationType": "PaymentOptionExpiration",
"storedPaymentOptions":
[
{
"storedPaymentOptionReference": "{reference of the stored payment option to be expired}",
"paymentOptionCode": "{payment option code of the stored payment option to be expired}",
"validUntil": "{validity date of the stored payment option to be expired as YYYY-MM-DD}",
"accno": "{account number to which the stored payment option above belongs}",
"externalAccountReference": "{external account reference of the account above}"
}
]
}

{
  "notificationType": "RejectExpiredStoredPaymentOption",
  "storedPaymentOptionReference": "{Unique Reference of the Expired Stored Payment Option}",
  "validUntil": "{Validity Date of the Expired Stored Payment Option, format 'YYYY-MM-DD'}",
  "accno": "{Account Number to which the Expired Stored Payment Option belongs to}",
  "externalAccountReference": "{External Account Reference of the above Account}"
}

{
    "notificationType": "AuthorizationFeedback",
    "processingStatus": "Status of transaction processing: 'Success' or 'Failed'",
    "processingReason": "Description of the transaction processing status",
    "transactionStatus": "RECEIVED or AUTHORIZED",
    "uniqueReference": "Unique reference of the transaction",
    "relatedTransactionReferences": [ {Array of transaction references of dependent transactions which are updated} ]
}