API Reference

Submit Order

post
https://pt-api.wpay.com.au/gifting/gco/gco/client/api/v1/orders

This API allows you to place an order for one or more gift cards. Gift cards will be activated in real-time and delivered back to you, or to your end-customer(s) based on your commercial agreement.

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

Unique order reference identifier you generate and supply

string | null

Used to associate related orders. For example, linking a refund to the original order.

string | null

Client Transaction Id

string | null

Unique invoice number for the order

paymentInfo
object
customerInfo
object
string | null

Client consumer reference to distinguish client's customer types types

string | null

Cart identifier for the order

string | null

Client application identifier to distinguish between different channels within the same merchant

giftItemsInfo
array of objects
required

Gift items within the order

giftItemsInfo*
string | null

Store identifier where the order is initiated from

orderNote
object
billingInfo
object
Headers
string
required

Correlation Id

string
required

Idempotency Key

Responses

Updated 11 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago

Did this page help you?