1. Home
  2. Docs
  3. API Documentation
  4. IPN (Instant Payment Notification)

IPN (Instant Payment Notification)

URL

Production:
https://endpoints.yenepay.com/api/verify/ipn 
Sandbox: https://testapi.yenepay.com/api/verify/ipn/ 

Description

Verifies the validity and integrity of a received IPN request on your IPN endpoint

Method

POST

Headers

Content-Type: application/json

Parameters

{
totalAmount (decimal): the total amount of this payment in ETB expressed as decimal. You will get this value when receiving IPN on your IPN url endpoint.
buyerId (string): a unique identifier of the paying customer as set in YenePay’s platform. You will get this value when receiving IPN on your IPN url endpoint.
merchantOrderId(string): the order id for this payment set on your platform. You will get this value when receiving IPN on your IPN url endpoint.
merchantId(string): your YenePay merchant account unique identifier. You will get this value when receiving IPN on your IPN url endpoint.
merchantCode(string): your YenePay merchant account code. You will get this value when receiving IPN on your IPN url endpoint.
transactionId(string): a unique identifier id of the payment transaction that is set on YenePay’s platform. You will get this value when receiving IPN on your IPN url endpoint.
status(string): the status code of the payment transaction. You will get this value when receiving IPN on your IPN url endpoint.
transactionCode(string): the order code for this transaction that is set on YenePay platform. You will get this value when receiving IPN on your IPN url endpoint.
currency(string): the currency for this payment. Should be se to “ETB”
signature(string): the payment signature for this transaction. You will get this value when receiving IPN on your IPN url endpoint.
}

Example Request

{
"totalAmount":1.00,
"buyerId":"37b20de1-5e1f-443f-b575-3ea79dc1b9f2",
"merchantOrderId":"51",
"merchantId":"02e1aaa5-ed29-408e-a24b-eddd665c3e8f",
"merchantCode":"0325",
"transactionId":"12137c4e-6ef1-4a78-b0ae-a058ba21c0ff",
"status":"9",
"transactionCode":"8087",
"currency":"ETB",
"signature":"oN88OCmKmUu7sp4ihh//1/FPmdnrdaL/HjhxOkYSIby2pq+F4Tq9NMz6KMuWEj2x7WkrkFDjvbjZaU4Varfl8Uun4JpXOBbmon1NQ1vcQ2CvrgZHwbCZljU54CtSnw4Bkv/qCxm5MWOOMBuq4fu2AyjRCKcEjf7vKixut5y+5lhq437AOWiNoLkdJQeLgp/2KeVKofpVsmmcHWP1g/+gCIjLhJyhp5zgUul3KyiIbNrxcg5Bojx5k79pR/EwPIaQZDfrfHJUuYIMGUH3bZhnBhhTYrl6z9hPG5uOblFVyu+qt0WgQ6NWq3FJRkl0k/kxg8zUV9llFp+IUZ2RASBzrw=="
}

Response

Success Response: 200
Body:

{
"VERIFIED"
}

Was this article helpful to you? Yes No

How can we help?