# Woolworths Group Instruments API

**Canonical:** https://apis.io/apis/woolworths-group/woolworths-group-instruments-api/  
**Provider:** Woolworths Group — https://apis.io/providers/woolworths-group/  
**Base URL:** https://pt-api.wpay.com.au/gifting  
**Documentation:** https://developerhub.wpay.com.au/giftingservices/docs/

Woolworths Group Instruments API is one of 18 APIs that [Woolworths Group](https://apis.io/providers/woolworths-group/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 30 JSON Schema definitions. Tagged areas include Instruments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 30 JSON Schemas.

The Instruments API from Woolworths Group — 4 operation(s) for instruments.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| GET | `/merchants/{merchantId}/instruments/{instrumentId}` | Instrument Details |
| GET | `/merchants/{merchantId}/sessions/{sessionId}` | Session Details |
| POST | `/merchants/{merchantId}/instruments/{instrumentId}/cancel` | Cancel Instrument |
| POST | `/merchants/{merchantId}/session/instrument` | Instrument Session |

## Machine-readable artifacts (36)

- **OpenAPI** — https://artifacts.apis.io/woolworths-group/openapi/woolworths-group-instruments-api-openapi.yml
- **Documentation** — https://developerhub.wpay.com.au/giftingservices/docs/
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-product-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-info-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-data-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-program-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-category-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-product-dto-paged-response-schema.json
- **Documentation** — https://developerhub.wpay.com.au/giftingservices/docs/becoming-a-gifting-partner
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-digital-cards-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-activated-cards-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-digital-order-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-physical-order-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-status-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-processing-response-schema.json
- **Documentation** — https://developerhub.wpay.com.au/cardsconnect/docs/cards-connect
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-transaction-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cancel-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-transaction-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cancel-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-create-key-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-api-key-details-schema.json
- **Documentation** — https://developerhub.wpay.com.au/cardsconnect/reference/connextor-api-set-for-in-store-transactions
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-authorization-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-transaction-detail-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-account-status-inquiry-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-account-status-inquiry-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-refunds-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-voids-response-schema.json
- **Documentation** — https://developerhub.wpay.com.au/payto/docs/what-is-payto
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-payment-details-view-model-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-refund-details-view-model-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-payment-details-by-payment-id-view-model-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-merchant-session-view-model-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-refund-details-by-refund-id-view-model-schema.json
- **JSONSchema** — https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-commands-merchant-initiate-payment-merchant-initiate-payment-command-schema.json

## Other Woolworths Group APIs (12)

- [Wpay Digital Acceptance](https://apis.io/apis/woolworths-group/wpay-digital-acceptance/)
- [Woolworths Group Account Status Inquiry API](https://apis.io/apis/woolworths-group/woolworths-group-accountstatusinquiry-api/)
- [Woolworths Group Activating Physical Gift Cards API](https://apis.io/apis/woolworths-group/woolworths-group-activating-physical-gift-cards-api/)
- [Woolworths Group Authorization API](https://apis.io/apis/woolworths-group/woolworths-group-authorization-api/)
- [Woolworths Group Capture API](https://apis.io/apis/woolworths-group/woolworths-group-capture-api/)
- [Woolworths Group Gifting Catalogue API](https://apis.io/apis/woolworths-group/woolworths-group-gifting-catalogue-api/)
- [Woolworths Group Health check API](https://apis.io/apis/woolworths-group/woolworths-group-health-check-api/)
- [Woolworths Group Key Management API](https://apis.io/apis/woolworths-group/woolworths-group-key-management-api/)
- [Woolworths Group Order API](https://apis.io/apis/woolworths-group/woolworths-group-order-api/)
- [Woolworths Group Ordering Digital Gift Cards API](https://apis.io/apis/woolworths-group/woolworths-group-ordering-digital-gift-cards-api/)
- [Woolworths Group Payments API](https://apis.io/apis/woolworths-group/woolworths-group-payments-api/)
- [Woolworths Group Refund API](https://apis.io/apis/woolworths-group/woolworths-group-refund-api/)

## Tags

Instruments

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/woolworths-group/woolworths-group-instruments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/woolworths-group/.