Card Purchase Notify

This notification is triggered when a purchase is processed on a card.

https://<customerHost:Port>/handlenotification

Header

Field	Description
Content-Type	application/json

Request example

curl --location --request POST 'https://<customerHost:Port>/handlenotification' \
-H 'Content-Type: application/json' \
-d '{
      "notificationType": "CARD_PURCHASE_NOTIFY",
      "notificationCreationTime": "2025-03-07T15:10:52.451Z",
      "notificationContent": {
        "notificationKey": "D8CCR7aK5HMEBKYG",
        "cardReference": "0UwIg396z_EfegG1SeLQJLi1I",
        "cardCurrency": "USD",
        "transactionReference": "0UwIEGFh7fUHpNyUJDbsQeVbImN",
        "approvalCode": "123456",
        "purchaseType": "PURCHASE",
        "merchantName": "Merchant Name",
        "purchaseCurrency": "USD",
        "purchaseAmount": 150.00",
        "cardAdjustmentAmount": "150.00"
      }
    }'

Request Body

Field	Description	Type
notificationType	Specifies the type of notification being sent.	string required
notificationCreationTime	Specifies the creation date and time for the notification. The date format conforms to ISO 8601	string required
notificationContent	Specifies the notification content	object required

Properties of notificationContent

Field	Description	Type
notificationKey	Represents a unique identifier for Nium that confirms the API method call is genuine	string required
cardReference	Represents a unique identifier for the virtual card	string required
cardCurrency	Represents the virtual card's currency in ISO 4217 format (e.g., USD).	string required
transactionReference	Represents a unique identifier for transaction	string
approvalCode	Contains the code with which the authorisation is labelled when approved	string required
purchaseType	Represents the type of purchase operation. REFUND refers to funds returned against a previous purchase and ORIGINAL_CREDIT refers to funds credited by a merchant independent of a purchase. Possible values: PURCHASE, REFUND, ORIGINAL_CREDIT	string required
merchantName	Contains the name of the merchant where the purchase occurred	string required
purchaseCurrency	Indicates the currency of the purchase, which may differ from the virtual card's currency, and follows the ISO 4217 format (e.g., USD)	string required
purchaseAmount	Contains the purchase amount in the purchase currency	string required
cardAdjustmentAmount	Contains the amount of funds that were adjusted on the virtual card (in the virtual card currency) as a result of this purchase	string