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 Instruments API

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

Woolworths Group Instruments 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 Instruments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 30 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 3 base URLs: https://uat-api.wpay.com.au/wpay-npp-payto/merchant-gateway/, https://pt-api.wpay.com.au/wpay-npp-payto/merchant-gateway/, https://api.wpay.com.au/wpay-npp-payto/merchant-gateway/.

4 operations 4 paths 30 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 4

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

Instruments 4
GET
/merchants/{merchantId}/instruments/{instrumentId}
Instrument Details
getMerchantsByMerchantIdInstrumentsByInstrumentId 3 params → 200400401403404500
GET
/merchants/{merchantId}/sessions/{sessionId}
Session Details
getMerchantsByMerchantIdSessionsBySessionId 3 params → 200400401403404500
POST
/merchants/{merchantId}/instruments/{instrumentId}/cancel
Cancel Instrument
postMerchantsByMerchantIdInstrumentsByInstrumentIdCancel 3 params → 204400401403500
POST
/merchants/{merchantId}/session/instrument
Instrument Session
postMerchantsByMerchantIdSessionInstrument 2 params body → 201400401403500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Merchant.API.Application.Queries.ViewModels.MerchantSessionViewModel (12 properties), Merchant.API.Application.Queries.ViewModels.InstrumentDetailsViewModel (10 properties), Merchant.API.Application.Queries.ViewModels.SessionDetails.PaymentViewModel (9 properties), Merchant.API.Application.Webhooks.InstrumentUpdated.InstrumentUpdatedWebhookPayload (8 properties). Each schema is shown below with its type and property counts.

Merchant.API.Swagger.Examples.BadRequestExamples.ProblemDetails404ResponseModel
object
4 properties
Merchant.Domain.Enums.InstrumentStatus
string
The PayTo Instrument status in the context of this session.
Merchant.API.Application.Webhooks.InstrumentPaused.InstrumentSuspensionReason
object
Suspension reason details.
3 properties
Merchant.API.Application.Webhooks.InstrumentCreated.InstrumentCreatedWebhook
object
5 properties 5 required
Merchant.API.Application.Queries.ViewModels.SessionDetails.InstrumentViewModel
object
This object contains the PayTo instrument details.
5 properties 3 required
Merchant.API.Application.Queries.ViewModels.SessionDetails.PaymentViewModel
object
This object contains the payment details.
9 properties 4 required
Merchant.Domain.Enums.SessionStatus
string
The current status of this session.
Merchant.API.Application.Queries.ViewModels.SessionDetails.BuyerViewModel
object
This object contains the buyer details.
2 properties 1 required
Merchant.API.Application.Webhooks.InstrumentUpdated.InstrumentUpdatedWebhookPayload
object
8 properties 5 required
Merchant.API.RequestDtos.CreateSession.Instrument.CreateInstrumentSessionRequestDto
object
3 properties 3 required
Merchant.API.RequestDtos.CreateSession.InstrumentSimulationDto
object
A sandbox only parameter than allows you to simulate the outcome of this instrument. Please refer to the developer guide for more info.
2 properties 1 required
Merchant.API.Application.Webhooks.InstrumentResumed.InstrumentResumedWebhookPayload
object
4 properties 3 required
Merchant.API.Application.Webhooks.InstrumentPaused.InstrumentPausedWebhook
object
5 properties 5 required
Merchant.Domain.Enums.InstrumentType
string
The type of the PayTo instrument.
Merchant.API.Swagger.Examples.BadRequestExamples.ProblemDetails400ResponseModel
object
5 properties 5 required
Merchant.API.Application.Webhooks.InstrumentCreated.InstrumentCreatedWebhookPayload
object
8 properties 5 required
Merchant.API.Application.Webhooks.InstrumentUpdated.InstrumentUpdatedWebhook
object
5 properties 5 required
Merchant.API.Application.Webhooks.InstrumentResumed.InstrumentResumedWebhook
object
5 properties 5 required
Merchant.API.RequestDtos.CreateSession.Instrument.InstrumentDto
object
This object contains the PayTo instrument details.
4 properties 1 required
Merchant.API.RequestDtos.CreateSession.BuyerDto
object
This object contains the buyer details.
2 properties 1 required
Merchant.API.Application.Webhooks.InstrumentPaused.InstrumentPausedWebhookPayload
object
5 properties 3 required
Merchant.API.Application.Webhooks.InstrumentCancelled.InstrumentCancellationReason
object
Cancellation reason details.
3 properties
Merchant.API.Application.Queries.ViewModels.Enums.InstrumentStatus
string
Latest instrument status.
Merchant.API.Application.Webhooks.InstrumentCancelled.InstrumentCancelledWebhookPayload
object
5 properties 3 required
Merchant.Domain.Enums.SessionType
string
The type of session that was created.
Merchant.API.Application.Queries.ViewModels.MerchantSessionViewModel
object
12 properties 10 required
Merchant.API.Application.Queries.ViewModels.InstrumentDetailsViewModel
object
10 properties 5 required
Merchant.API.Application.Queries.ViewModels.Enums.InstrumentLabelType
string
The instrument's label type. BBAN represents a Bank Account, PayID represents a PayID. For best customer experience, please use this when displaying the instru…
Merchant.Domain.Enums.PaymentStatus
string
The PayTo payment status in the context of this session.
Merchant.API.Application.Webhooks.InstrumentCancelled.InstrumentCancelledWebhook
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

woolworths-group-instruments-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 Key Management API
Woolworths Group Order API
Woolworths Group Ordering Digital Gift Cards API
Woolworths Group Payments API
Woolworths Group Refund API
Where this information came from

This is an independent, third-party profile of Woolworths Group Instruments 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.