API Reference

Activate Physical Gift Card

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

This API allows you to activate a physical gift card.

Body Params
payments
array of objects
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
length between 1 and 1

Only one single physical card may be activated per API call.

products
string

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

number

The currency amount to load onto the gift card.

number
Defaults to 1

Only 1 physical card may be activated per API call.

string
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

The card number of the gift card to be activated

string

The trackData or barcode of the gift card

string
required
length ≤ 55

A unique order reference identifier you generate and supply.

string

The outlet name from where the gift card activation is triggered. This is required for partners who have multiple outlets

string
Defaults to FULFILLMENT_BY_SELLER

Physical card activations require the value 'FULFILLMENT_BY_SELLER'.

boolean
required
Defaults to true

Always supply the value of true

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