API Reference

Create a new order

post
https://api.gratifypay.com/bnpl/2.0/orders

Creates a new order specifying the merchantId, consumerId, and payment method in the request body. Additional order-related fields should also be provided.

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

The merchant that the order is associated with

string
required

The consumer that this order is associated with

string
required

The payment method token that this order is associated with

string
enum

Platform that this order originated from

price
object

Total price of the order items

priceTaxes
object

Price of taxes or zero if not provided

priceShipping
object

Price of shipping or zero if not provided

pricePromo
object

Price adjustment of promo code or zero if not provided

items
array of objects
required

Array of items in the cart

items*
string

Optional custom ID provided by the merchant on order creation (merchant domain order id)

string

Optional custom XML, JSON or similar data provided and managed by the partner API client. Stored with the Gratify Order.

string

Optional data provided by the partner API client as an index or link back to the client-side equivalent model. Stored with the Gratify Order.

string

Optional custom XML, JSON or similar data provided and managed by the partner API client. Stored with the Gratify Order.

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