Get notified of a transaction status change

Receive notifications of transaction status changes as your user progresses through the payment flow.

During the payment flow, the transaction status will be one of the following:

• Pending

• Successful

• Failed

You will be notified whenever a transaction is marked as 'Successful' or 'Failed' via the Transaction Completion Notification URL configured in the publisher portal.

Pre-requisite

• The transaction completion notification URL is configured

Notification parameters

Notifications are sent to the configured transaction completion notification URL with the appended query parameters below.

Parameters	Description
TxnId	Always The transaction ID generated during the payment request initiation
OrderId	Always Your Order ID, passed during the payment request initiation
ResultCode	Always The ResultCode will help indicate the status of the transaction. ResultCode = 0 means the transaction is successful. ResultCode = 431 or 216 means that the transaction is pending. All other ResultCode values mean that the transaction Failed. You can find the full list of error codes and their explanation here.
TotalPrice	Always The total amount the user has paid for the transaction. This will always be in local currency.
PaymentType	Always The PaymentType the user attempted to pay with. PaymentType is equal to the payment channel ID or 1 in case the payment channel is a Carier Billing.
Checksum	Always The checksum helps verify that the message is sent by Codapay and has not been tampered with.
MnoId	Optional If the need_mno_id parameter was used during payment channel initiation, this parameter will contain the payment channel ID
USDPrice	Optional If a transaction is initiated in a country where USD is not the local currency, the Coda callback parameter (TotalPrice) will default display the user's local currency amount. If you require adding the initial USDPrice to the callback, please contact the Codapay support team. Refer to the USD pricing section for more details.

Expected Response

After sending the notification, Codapay expects an acknowledgment to confirm it has been received.

If your application processes the notification successfully, respond with 'ResultCode=0.' Otherwise, return an error code.

If no response is received, the notification will be resent three times at 5-minute intervals.

Samples

Notification

https://mynotificationurl.com?TxnId=7178589013775074766&OrderId=12321312321314&TotalPrice=100&PaymentType=101&ResultCode=0&Checksum=```postman_json
e944d44f065eade8157737385a094a57

Response

ResultCode=0

Checking a transaction status

We highly recommend using the InquiryPaymentResult API call after receiving the purchase notification webhook. This will help reconcile the transaction status between your system and Coda's before releasing the purchased item.