API Reference

Order Digital Gift Cards

post
https://pt-api.wpay.com.au/v1/partner/giftcards/orders

This API allows you to place an order for one or more digital gift cards. The endpoint can operate in both real-time and batch modes. Consult the usage guide for information about these two order types and the type-specific sequence of events.

Body Params
payments
array of objects
required
length between 1 and 1

The account the gift card amounts will be deducted from. Requires one single element to indicate the payment will be made using the SVA.

payments*
string
enum
required
Defaults to svc

Always use the code 'svc'.

Allowed:
number
required

The payment amount for the order. This value must match the sum of 'price' times 'qty' for all cards in this order.

products
array of objects
required
length ≥ 1

The details of the gift card(s) that you wish to order.

products*
string
required

The gift card identifier (SKU). The list of gift cards you may order will be predefined and shared during the onboarding process.

number
required

The currency amount to load onto the gift card.

number
required

The number of gift cards you wish to order with this SKU and price combination.

string
required
length between 3 and 3

Use 036 for AUD currency. The full list of valid codes is defined at https://en.wikipedia.org/wiki/ISO_4217

string
required
length ≤ 55

A unique order reference identifier you generate and supply. This identifier is used in the batch order process when retreiving order status. It is also used in real-time orders during the error recovery process.

boolean
required

Indicates if the order shall be processed in real-time or in batch mode. Supply true to process in real-time. Supply false to process as a batch. Note, there is a 10 card limit on real-time orders. Consult the usage guide for information about these two order types and the type-specific sequence of events.

string
enum
required
Defaults to API

This field is used to specify how the gift card details will be delivered. Only ‘API’ is supported.

Allowed:
Responses

Updated almost 4 years ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated almost 4 years ago