Payment Notifications

This endpoint is used to notify Casava when the policyholder has completed their payment.

Used to notify casava of completed payment from a policy holder via the channel

POSThttps://channel.sandbox.casava.co/api/channel-service/v1/paymentNotifications

Authorization

api_key

Header parameters

Body

application/json

Used to notify casava of completed payment from a policy holder via the channel

paymentReference*string

unique payment reference from the channel used to identify policy holder payment

Example: "ref123"

policyHolderNumberstring

policy holder system generated unique identifier

Example: "12345678"

amount*number

payment amount

Example: 50

currencystring

payment amount currency

Example: "NGN"

paymentDatestring

transaction payment date

Example: "2021-10-23"

paymentEffectiveDatestring

settlement payment date for reconcillation purpose

Example: "2021-10-23"

paymentChannelstring

channel used to complete payment

Example: "MOBILE"

policyNumberstring

unique reference used to identify a policy with a policy holder

Example: "12345623"

Response

200400

successful operation

Body

application/json

paymentReference*string

unique payment reference from the channel used to identify policy holder

Example: "ref123"

processingReference*string

payment reference number generated by the system

Example: "ref123"

policyHolderNumberstring

policy holder system generated unique identifier

Example: "12345678"

amount*number

payment amount

Example: 50

statusenum

allowed data type for the field

Example: "success"

pendingsuccessrejected

Request

JavaScriptCurlPython

const response = await fetch('https://channel.sandbox.casava.co/api/channel-service/v1/paymentNotifications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 50,
      "paymentReference": "ref123"
    }),
});
const data = await response.json();

Response

200400

{
  "paymentReference": "ref123",
  "processingReference": "ref123",
  "policyHolderNumber": "12345678",
  "amount": 50,
  "status": "success"
}

Sample Request

{
  "paymentReference": "ref123",
  "policyHolderNumber": "080292929215",
  "amount": 50,
  "currency": "NGN",
  "paymentDate": "2021-10-23",
  "paymentEffectiveDate": "2021-10-23",
  "paymentChannel": "MOBILE",
  "policyNumber": "12222070620220118800055"
}

Sample Response

{
  "statusCode": 200,
  "message": "successful operation",
  "data": {
    "paymentReference": "ref123",
    "policyHolderNumber": "080209934213519",
    "amount": 50,
    "status": "pending",
    "processingReference": "ref123"
  }
}