Refund HTTP Push Notification
  • 04 Apr 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Refund HTTP Push Notification

  • Dark
    Light
  • PDF

Article summary

This callback notification will update the merchant once a refund transaction is processed for each pending refund request. The notification will be initiated from SmartLink to the merchant, as there will be no need for the merchant to issue any request to receive this notification, only setting up the interface which will receive this notification. This message is sent as an HTTP Request containing the below parameters.

Output Parameters

ParameterDescription
Response.MessageID
required 
Numeric value representing the refund message ID, this value will always be (4).
This value will be used only on refund notification to distinguish it from payment notification.

  • Field Type: Numeric
  • Length: 1
  • Sample Data: 4

Response.MerchantID
required 

Alphanumeric value representing the merchant Id.

  • Field Type: Alphanumeric
  • Length: 40
  • Sample Data: maisMerchant
Response.InvoiceId
required

 Alphanumeric value representing the Invoice ID.

  • Field Type: Alphanumeric
  • Length: 60
  • Sample Data: 56534333
Response.InvoiceStatus
required 

Alphanumeric value representing the invoice status.

Possible values are: 

  • SUCCESSFUL
  • PENDING
  • FAILED

  • Field Type: Alphanumeric
  • Length: 10
  • Sample Data: SUCCESSFUL
Response.Amount
required 

A numeric value represents the invoice amount that is sent from the merchant upon invoice creation. It will be ISO formatted with no decimal point.

  • Field Type: Numeric
  • Length: 9
  • Sample Data: 100
Response.CurrencyISOCode
required
The numeric ISO Code of the currency for the invoice. This value represents the currency ISO code sent by the merchant upon invoice creation

  • Field Type: Numeric
  • Length: 3
  • Sample Data: 400
Response.RRN
optional
The Reference Retrieval Number of the refund.

  • Field Type: Alphanumeric
  • Length: 50
  • Sample Data: 201608161029435230000000000
Response.ApprovalCode
optional
The Approval code for the refund.

  • Field Type: Alphanumeric
  • Length: 10
  • Sample Data: 0000125480
Response.RefundAmount
required
A numeric value represents the refunded amount. It will be ISO formatted with no decimal point.


  • Field Type: Numeric
  • Length: 9
  • Sample Data: 100


HTTP Authentication Parameters

The below parameters will be included within the HTTP authorization request header as a basic authentication.

ParameterDescription
username
optional

An Alphanumeric value representing the username Provided by the merchant.

  • Field Type: Alphanumeric
  • Length: 255
  • Sample Data: user123
password
optional

An Alphanumeric value password provided by the merchant.

  • Field Type: Alphanumeric
  • Length: 255
  • Sample Data: P@ssword