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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Woolworths Group

Woolworths Group Payments API

The Payments API from Woolworths Group — 5 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 5 operations across 5 paths, and defines 43 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/.

5 operations 5 paths 43 schemas 2 GET3 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
Wpay
Resource Areas
1

Paths & Operations 5

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

Payments 5
GET
/merchants/{merchantId}/payments/{paymentId}
Payment Details
getMerchantsByMerchantIdPaymentsByPaymentId 3 params → 200400401403404500
GET
/merchants/{merchantId}/sessions/{sessionId}
Session Details
getMerchantsByMerchantIdSessionsBySessionId 3 params → 200400401403404500
POST
/merchants/{merchantId}/instruments/{instrumentId}/payment
Make Payment
postMerchantsByMerchantIdInstrumentsByInstrumentIdPayment 3 params body → 201400401403404422500
POST
/merchants/{merchantId}/session/checkout
Checkout Session
postMerchantsByMerchantIdSessionCheckout 2 params body → 201400401403500
POST
/merchants/{merchantId}/session/payment
Payment Session
postMerchantsByMerchantIdSessionPayment 2 params body → 201400401403500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Merchant.API.Application.Queries.ViewModels.PaymentDetailsViewModel (13 properties), Merchant.API.Application.Queries.ViewModels.PaymentDetailsByPaymentIdViewModel (13 properties), Merchant.API.Application.Queries.ViewModels.MerchantSessionViewModel (12 properties), Merchant.API.Application.Webhooks.PaymentCompleted.PaymentCompletedWebhookPayload (9 properties). Each schema is shown below with its type and property counts.

Merchant.API.Application.Queries.ViewModels.PaymentDetailsViewModel
object
The payment details.
13 properties 7 required
Merchant.API.Swagger.Examples.BadRequestExamples.ProblemDetails404ResponseModel
object
4 properties
Merchant.API.Application.Queries.ViewModels.Enums.MerchantStatus
string
Latest payment status. Processing indicates the payment is still being processed by the NPP. Completed indicates the payment has been successfully settled and…
Merchant.API.RequestDtos.CreateSession.Payment.PaymentDto
object
This object contains the payment details.
9 properties 3 required
Merchant.Domain.Enums.InstrumentStatus
string
The PayTo Instrument status in the context of this session.
Merchant.API.Application.Webhooks.PaymentCompleted.PaymentCompletedWebhook
object
5 properties 5 required
Merchant.API.RequestDtos.CreateSession.Payment.CreatePaymentSessionRequestDto
object
3 properties 3 required
Merchant.API.Application.Webhooks.PaymentRejected.PaymentRejectedWebhook
object
5 properties 5 required
Merchant.API.Application.Webhooks.PaymentRejected.PaymentRejectedWebhookPayload
object
7 properties 5 required
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.Swagger.Examples.BadRequestExamples.UnprocessableEntityResponseModel
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.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.PaymentRejected.PaymentRejectionReason
object
Rejection reason details.
3 properties
Merchant.API.Application.Webhooks.InstrumentResumed.InstrumentResumedWebhook
object
5 properties 5 required
Merchant.API.RequestDtos.CreateSession.Checkout.InstrumentDto
object
This object contains the PayTo instrument details.
5 properties 2 required
Merchant.API.RequestDtos.CreateSession.BuyerDto
object
This object contains the buyer details.
2 properties 1 required
Merchant.API.RequestDtos.CreateSession.Checkout.PaymentDto
object
This object contains the payment details.
8 properties 2 required
Merchant.API.Application.Queries.ViewModels.PaymentRejectionReasonViewModel
object
Rejection reason details in case of payment failure.
3 properties 3 required
Merchant.API.Application.Webhooks.InstrumentCancelled.InstrumentCancellationReason
object
Cancellation reason details.
3 properties
Merchant.API.Application.Webhooks.InstrumentPaused.InstrumentPausedWebhookPayload
object
5 properties 3 required
Merchant.API.Swagger.Examples.BadRequestExamples.ErrorModel
object
3 properties 2 required
Merchant.API.RequestDtos.CreateSession.PaymentSimulationDto
object
A sandbox only parameter than allows you to simulate the outcome of this payment. Please refer to the developer guide for more info.
2 properties 1 required
Merchant.API.RequestDtos.CreateSession.Checkout.CreateCheckoutSessionRequestDto
object
4 properties 4 required
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.PaymentDetailsByPaymentIdViewModel
object
13 properties 7 required
Merchant.API.Application.Webhooks.PaymentCompleted.PaymentCompletedWebhookPayload
object
9 properties 5 required
Merchant.API.Application.Queries.ViewModels.MerchantSessionViewModel
object
12 properties 10 required
Merchant.API.Application.Commands.MerchantInitiatePayment.MerchantInitiatePaymentCommand
object
The payment details.
8 properties 2 required
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-payments-api-openapi.yml Raw ↑

Other APIs Woolworths Group publishes across the network.

Wpay Digital Acceptance
AE Profile APIs.io
Woolworths Group Account Status Inquiry API
AE Profile APIs.io
Woolworths Group Activating Physical Gift Cards API
AE Profile APIs.io
Woolworths Group Authorization API
AE Profile APIs.io
Woolworths Group Capture API
AE Profile APIs.io
Woolworths Group Gifting Catalogue API
AE Profile APIs.io
Woolworths Group Health check API
AE Profile APIs.io
Woolworths Group Instruments API
AE Profile APIs.io
Woolworths Group Key Management API
AE Profile APIs.io
Woolworths Group Order API
AE Profile APIs.io
Woolworths Group Ordering Digital Gift Cards API
AE Profile APIs.io
Woolworths Group Refund API
AE Profile APIs.io
#Payments
← Back to W APIs
API Details
ID
woolworths-group:woolworths-group-payments-api
Base URL
https://pt-api.wpay.com.au/gifting
Docs
https://developerhub.wpay.com.au/giftingservices/docs/
Provider
Woolworths Group
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=woolworths-group-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/woolworths-group-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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