Gratify Partners can be notified of Gratify events

Event Notifications

Gratify Partners can configure their accounts to receive HTTP notifications of key Gratify events.

The {partnerUrl} can be set to a URL of a system owned by the Partner (for example https://api.acmepartner.com/gratifynotify).

From this endpoint, the Partner can then use the Gratify Partner API to retrieve additional details and status about the order.

Contact your Gratify support representative to configure {partnerBaseUrl} for your Gratify Partner account.

Event

Notification URL

New Order

POST {partnerBaseUrl}/order-new

Refunded Order

POST {partnerBaseUrl}/order-refunded

Chargeback Order

POST {partnerBaseUrl}/order-chargeback

Event Data

Each HTTP POST notification will contain the following fields in POST message body

Attribute name

Type

Description

partnerId

string

Unique ID for the Gratify Partner associated with the order. For example "partner_ngFXNRrnx33s"

merchantId

string

Unique ID for the Gratify Merchant associated with the order. For example "merchant_fenr66RRsh3sa"

orderId

string

Unique order ID generated by Gratify "order_dBfgheRTT43sz"

Use this ID to retrieve additional order details with the Partner API