Callback to receive transaction compliance status

Overview

Nium sends a notification to the client callback URL when there's a change in compliance status and displays action is required for further processing.

POST https://<clientURL>?type={requestType}&value={requestValue}

Example: https://abc.com?type=TRANSACTION&value=FW2214491490
In this example, if the request type is TRANSACTION and the request value is any transactionId, it indicates a change in status for the transaction. Clients can call the Transactions API to check the latest status of the transaction. If a request for information (RFI) is raised, a response is filed using the Respond to Transaction RFI API.

Security

This API only supports the HTTPS protocol. You need to add Classless Inter-Domain Routing (CIDR) block of Nium to your firewall IP allowlist to make sure only Nium is authorized to make the call.

Request example

curl -X POST \
  'https://<clientURL>?type={nudgeType}&value={nudgeValue}' \
  -H 'content-type: application/json' \
  -H 'x-request-id: 123e4567-e89b-12d3-a456-426655440000' \
  -H 'x-client-name: client1' \
  -d '{
      "type" : "TRANSACTION",
      "value" : "FW2214491490",
      "clientHashId" : "82c68bab-3c04-3451-8d7b-cb38ad713d97",
      "customerHashId" : "91bd4b3b-458a-4a83-831b-7ea834492b19",
      "walletHashId" : "7bf8f915-edf6-44ff-970c-88a00795088d"
}'

Request body