Instant Payment Notification

Instant Payment Notification (IPN) is a message service that automatically notifies merchants of events related to OMPay payment transactions. Merchant can use it to automate back-office and administrative functions, including automatically fulfilling orders and providing customers with payment status.

Rather than requiring you to pull information via our API, IPN push information to your destination when important events occur.

Notifications are delivered via HTTPS POST to a destination URL on your server and are sent based on the triggers.

Notification Message structure

• id string

  Identifier of the Notification Message Sent

• create_time datetime

  Notification Message creation time as defined in RFC 3339 Section 5.6 (opens new window).

• resource_type string

  Notification resource type. Valid values are payment, subscription, account_updater

• kind string

  Event kind that triggered the notification

  • PAYMENT.AUTHORIZATION.CREATED

    Authorization is created successfully

  • PAYMENT.AUTHORIZATION.DENIED

    Authorization is declined for some reason

  • PAYMENT.SALE.COMPLETED

    Sale (authorisation and capture) successfully created.

  • PAYMENT.AUTHORIZATION.VOIDED

    Authorization successfully cancelled

  • PAYMENT.AUTHORIZATION.VOID.DENIED

    Authorization void declined for some reason

  • PAYMENT.CAPTURE.COMPLETED

    Payment transaction captured successfully

  • PAYMENT.CAPTURE.DENIED

    Payment transaction capture declined for some reason

  • PAYMENT.CAPTURE.DEFERRED

    Payment transaction capture deferred

  • PAYMENT.REFUND.COMPLETED

    Payment transaction refunded successfully

  • PAYMENT.REFUND.DENIED

    Payment transaction refund declined for some reason

  • PAYMENT.REFUND.DEFERRED

    Payment transaction refund deferred

• resource object

  payload associated with the notification event message. This payload will highly depend on the notification kind.

Configure IPN

1. Create a destination URL on the Dashboard to recieve IPN.
2. Add authorization header for IPN messages.
3. Set up your server to parse incoming webhooks