Woolworths Group Wallet Services API

openapi: 3.2.0
info:
  title: Wpay NPP PayTo Merchant Wallet Services API
  description: API endpoints to manage agreements and initiate and view PayTo payments.
  contact:
    name: Wpay
    url: https://wpay.com.au/
  version: v1
servers:
- url: https://uat-api.wpay.com.au/wpay-npp-payto/merchant-gateway/
  description: UAT
- url: https://pt-api.wpay.com.au/wpay-npp-payto/merchant-gateway/
  description: PT - Production Test
- url: https://api.wpay.com.au/wpay-npp-payto/merchant-gateway/
  description: Production
tags:
- name: Wallet Services
paths:
  /merchants/{merchantId}/buyers/{buyerId}/instruments:
    get:
      tags:
      - Wallet Services
      summary: Buyer Wallet
      description: Used to retrieve a list of saved PayTo payment instruments from a buyer's PayTo digital wallet.
      parameters:
      - name: x-request-id
        in: header
        description: Unique identifier for the request (GUID).<br/> This id will be used for tracking and troubleshooting problems associated with the request.
        required: true
        schema:
          type: string
      - name: merchantId
        in: path
        description: 'ID of the merchant. This unique value will be provided by Wpay as part of on-boarding.<br/>Note: Wpay uses the UUID v4 format for all the unique IDs we provide.'
        required: true
        schema:
          type: string
      - name: buyerId
        in: path
        description: ID of the merchant's buyer for which PayTo instruments will be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Merchant.API.Application.Queries.ViewModels.Wallet.WalletViewModel'
              example:
                merchantId: 4b694fc3-b178-402d-9a91-e76c61441c7c
                buyer:
                  buyerId: A000046252
                  buyerName: New-buyer
                payToInstruments:
                - instrumentId: f4dde998-e3e6-4ec8-ac2e-ab1837d847c7
                  instrumentLabelType: PAYID
                  instrumentLabel: joe.bloggs@email.com
                  isOneOff: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Merchant.API.Swagger.Examples.BadRequestExamples.ProblemDetails400ResponseModel'
              example:
                type: https://tools.ietf.org/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred.
                status: 400
                traceId: 00-d2eb5dc766296047344081d3de1e17e7-63809d2f07f7ea22-00
                errors:
                  merchantId:
                  - Merchant Id is required
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      security:
      - bearerAuth: []
      operationId: getMerchantsByMerchantIdBuyersByBuyerIdInstruments
      x-operation-id-source: derived
components:
  schemas:
    Merchant.API.Application.Queries.ViewModels.Wallet.WalletViewModel:
      required:
      - buyer
      - merchantId
      - payToInstruments
      type: object
      properties:
        merchantId:
          minLength: 1
          type: string
          description: ID of the merchant.
        buyer:
          $ref: '#/components/schemas/Merchant.API.Application.Queries.ViewModels.Wallet.WalletBuyerViewModel'
        payToInstruments:
          type: array
          items:
            $ref: '#/components/schemas/Merchant.API.Application.Queries.ViewModels.Wallet.InstrumentViewModel'
      additionalProperties: false
    Merchant.API.Application.Queries.ViewModels.Wallet.WalletBuyerViewModel:
      type: object
      properties:
        buyerId:
          type:
          - string
          - 'null'
          description: ID of the buyer for whom this session was created.
        buyerName:
          type:
          - string
          - 'null'
          description: The buyer or shopper full name as it is known to the merchant.
      additionalProperties: false
      description: This object contains the buyer details.
    Merchant.API.Swagger.Examples.BadRequestExamples.ProblemDetails400ResponseModel:
      required:
      - errors
      - status
      - title
      - traceId
      - type
      type: object
      properties:
        type:
          minLength: 1
          type: string
          description: A URI reference [RFC3986] that identifies the problem type.
        title:
          minLength: 1
          type: string
          description: A short, human-readable summary of the problem type.
        status:
          type: integer
          description: The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
          format: int32
        traceId:
          minLength: 1
          type: string
          description: ID for the request.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: ID of the PayTo instrument.
      additionalProperties: false
    Merchant.API.Application.Queries.ViewModels.Wallet.InstrumentViewModel:
      title: Instrument View Model
      required:
      - instrumentId
      - instrumentLabel
      - instrumentLabelType
      - isOneOff
      type: object
      properties:
        instrumentId:
          minLength: 1
          type: string
          description: ID of the PayTo instrument.
        instrumentLabelType:
          $ref: '#/components/schemas/Merchant.API.Application.Queries.ViewModels.Enums.InstrumentLabelType'
        instrumentLabel:
          minLength: 1
          type: string
          description: Instrument's label value that's recognisable by the consumer. Display this value when presenting the instrument to the consumer on store checkout or digital wallet web pages.
        isOneOff:
          type: boolean
          description: Indicates if this instrument can be used to make only one PayTo payment or multiple ones. True indicates that only one payment can be made by the instrument, False indicates multiple payments can be made by the instrument.
      additionalProperties: false
      description: This is the view model for the Instrument.
    Merchant.API.Application.Queries.ViewModels.Enums.InstrumentLabelType:
      title: Instrument Label Type
      enum:
      - BBAN
      - PAYID
      type: string
      description: The instrument's label type. BBAN represents a Bank Account, PayID represents a PayID. For best customer experience, please use this when displaying the instrument to the consumer on store checkout or digital wallet web pages.
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-assembled-from:
  note: Merged verbatim from the per-operation OpenAPI definitions Wpay (Woolworths Group payments business) embeds in each ReadMe reference page; raw pages saved under openapi/_original/wpay-developerhub/.
  retrieved: '2026-10-22'
  sources:
  - https://developerhub.wpay.com.au/payto/reference/get_merchants-merchantid-buyers-buyerid-instruments.md
  - https://developerhub.wpay.com.au/payto/reference/get_merchants-merchantid-instruments-instrumentid.md
  - https://developerhub.wpay.com.au/payto/reference/get_merchants-merchantid-payments-paymentid.md
  - https://developerhub.wpay.com.au/payto/reference/get_merchants-merchantid-refunds-refundid.md
  - https://developerhub.wpay.com.au/payto/reference/get_merchants-merchantid-sessions-sessionid.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-instruments-instrumentid-cancel.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-instruments-instrumentid-payment.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-payments-paymentid-refund.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-session-checkout.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-session-instrument.md
  - https://developerhub.wpay.com.au/payto/reference/post_merchants-merchantid-session-payment.md