How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Woolworths Group Ordering Digital Gift Cards API

The Ordering Digital Gift Cards API from Woolworths Group — 3 operation(s) for ordering digital gift cards.

Woolworths Group Ordering Digital Gift Cards API is one of 18 APIs that Woolworths Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 30 JSON Schema definitions.

Tagged areas include Ordering Digital Gift Cards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 30 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.2.0.

Requests are made against a single base URL, https://pt-api.wpay.com.au/v1/partner/giftcards.

3 operations 3 paths 14 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.0
Base URL
https://pt-api.wpay.com.au/gifting
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Woolworths Group Ordering Digital Gift Cards API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (X-Api-Key). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Ordering Digital Gift Cards 3
GET
/order/{orderId}/cards
Get Activated Cards
getActivatedGiftCards 3 params → 200400500
GET
/order/{refno}/status
Get Order Status
getGiftCardOrderStatus 1 param → 200400500
POST
/orders
Order Digital Gift Cards
orderGiftCards body → 201202400500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are cardDetailsObject (15 properties), OrderDigitalCardsResponse (8 properties), OrderProcessingResponse (6 properties), ActivatedCardsResponse (5 properties). Each schema is shown below with its type and property counts.

OrderProcessingResponse
object
Order Status Response
6 properties
productsMapObject
object
1 property 1 required
cardPurchaseObject
object
4 properties 4 required
paymentsResponseObject
array
The account the gift card amounts have or will be deducted from.
BusinessLogicErrorResponse
object
Payload for a business logic error
5 properties 1 required
paymentsObject
array
The account the gift card amounts will be deducted from. Requires one single element to indicate the payment will be made using the SVA.
DigitalOrderRequest
object
The JSON request structure of the Order endpoint.
5 properties 5 required
Error
object
Payload for an unexpected error
4 properties 4 required
OrderStatusResponse
object
The JSON response structure of Order Status endpoint
4 properties
cancelObject
object
This field is unused.
2 properties
OrderDigitalCardsResponse
object
Real-Time Order Response
8 properties 1 required
currencyObject
object
Contains details about the gift card currency.
3 properties
ActivatedCardsResponse
object
5 properties 2 required
cardDetailsObject
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

woolworths-group-ordering-digital-gift-cards-api-openapi.yml Raw ↑

Other APIs Woolworths Group publishes across the network.

Wpay Digital Acceptance
Woolworths Group Account Status Inquiry API
Woolworths Group Activating Physical Gift Cards API
Woolworths Group Authorization API
Woolworths Group Capture API
Woolworths Group Gifting Catalogue API
Woolworths Group Health check API
Woolworths Group Instruments API
Woolworths Group Key Management API
Woolworths Group Order API
Woolworths Group Payments API
Woolworths Group Refund API
Where this information came from

This is an independent, third-party profile of Woolworths Group Ordering Digital Gift Cards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.