Woolworths Group Support API

openapi: 3.2.0
info:
  title: WPay External Partner Integration Support API
  description: Gift Card API for External Partner Integration
  version: 1.2.0
servers:
- url: https://pt-api.wpay.com.au/v1/partner/giftcards
  description: Integration environment
security:
- X-Api-Key: []
tags:
- name: Support
paths:
  /orders/reverse:
    post:
      summary: Reverse an Order
      operationId: postOrdersReverse
      description: This API allows you to reverse an order. This API is to be used in the recovery of an order error when the order status is unknown due to a communications failure that prevented the receipt of the order request.
      tags:
      - Support
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderReversalRequest'
        required: true
      responses:
        '202':
          description: This successful response indicates that the reversal was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderReversalResponse'
        '400':
          description: This response code indicates that an error was encountered when reversing the order. The cause will be a validation problem or logic rule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderReversalErrorResponse'
        '500':
          description: This response code indicates that an unexpected error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    OrderReversalResponse:
      properties:
        code:
          type: number
          description: The response code. 0 indicates a successful response.
          example: 0
        message:
          type: string
          description: The response message.
          example: Successfully accepted the order for reversal
        messages:
          type: array
          description: Any additional informational messages
          items:
            type: string
        order:
          description: Order identifiers and status information.
          properties:
            status:
              type: string
              description: The current order status.
              example: PROCESSING
            orderId:
              type: string
              description: Wpay order identifier (ID).
              example: AAN9200073512
            refno:
              type: string
              description: The unique order reference identifier you supplied when ordering the digital gift cards.
              example: aaaa-bbbb-0000-0001
      example:
        code: 0
        message: Successfully accepted the order for reversal
        messages: []
        order":
          status: PROCESSING
          orderId: AAN9200073512
          refno: 001000000abc
    Error:
      required:
      - httpStatusCode
      - errorCode
      - errorMessage
      - errorDetail
      type: object
      description: Payload for an unexpected error
      properties:
        httpStatusCode:
          type: number
          description: The http status code (5xx HTTP status codes).
          example: 500
        errorCode:
          type: string
          description: The error code.
          example: AP99
        errorMessage:
          type: string
          description: The error message.
          example: Internal Server Error
        errorDetail:
          type: string
          description: The error detail.
          example: 'Oops! An error has occurred: ScriptExecutionFailed'
      example:
        httpStatusCode: 500
        errorCode: AP99
        errorMessage: Internal Server Error
        errorDetail: 'Oops! An error has occurred: ScriptExecutionFailed'
    OrderReversalRequest:
      required:
      - refno
      properties:
        refno:
          type: string
          description: The unique order reference identifier you supplied when ordering the digital gift cards.
          maxLength: 55
          example: aaaa-bbbb-0000-0001
    OrderReversalErrorResponse:
      required:
      - code
      type: object
      description: Payload for a business logic error
      properties:
        httpStatusCode:
          type: number
          description: The http status code
          example: 400
        errorCode:
          type: string
          description: The error code
          example: '8221'
        errorMessage:
          type: string
          description: The error message
          example: Order reversal already requested
        messages:
          type: array
          items:
            type: string
        additionalTxnFields:
          type: object
          properties:
            responseCode:
              type: number
              example: 10004
      example:
        httpStatusCode: 400
        errorCode: '8221'
        errorMessage: Order reversal already requested
        messages: []
  securitySchemes:
    X-Api-Key:
      type: apiKey
      name: X-Api-Key
      in: header
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/giftingservices/reference/activatephysicalgiftcard.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getactivatedgiftcards.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getgiftcardorderstatus.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getservicehealth.md
  - https://developerhub.wpay.com.au/giftingservices/reference/ordergiftcards.md
  - https://developerhub.wpay.com.au/giftingservices/reference/postordersreverse.md