API Reference

Create a Gratify Order

post
https://api.gratifypay.com/merchant/order-initialize

This will create a Gratify order. You pass in a return URL on success, shopping cart details, shipping details, etc. and receive an order map id. Once this API call is completed, the user should be redirected to the Gratify web app with this orderMapId as a parameter( ?o= ) to complete the purchase.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

The platform identifier used by the store. Check with Gratify support for which one to use for your ecommerce platform integration.

string

The reference ID of the merchant

uri

The URL to return to after completing the order

uri

The URL to receive callbacks for order updates

uri

The URL to redirect to in case of order failure

items
array of objects

The items in the order

items
shippingAddress
object

The shipping address for the order

string
enum

The shipping method for the order

Allowed:
number

The subtotal price of the order, in the configured currency of the authenticated merchant

number

The total shipping cost of the order, in the configured currency of the authenticated merchant

number

The total taxes applied to the order, in the configured currency of the authenticated merchant

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago