Woolworths Group Activating Physical Gift Cards API

openapi: 3.2.0
info:
  title: WPay External Partner Integration Activating Physical Gift…
  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: Activating Physical Gift Cards
paths:
  /activations/physical:
    post:
      summary: Activate Physical Gift Card
      operationId: activatePhysicalGiftCard
      description: This API allows you to activate a physical gift card.
      tags:
      - Activating Physical Gift Cards
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhysicalOrderRequest'
        required: true
      responses:
        '201':
          description: This response code indicates the physical gift card activation has been successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhysicalOrderResponse'
        '400':
          description: This response code indicates that an error was encountered when submitting the order. The cause will be a validation problem or logic rule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLogicErrorResponse'
        '500':
          description: This response code indicates that an unexpected error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    OrderProcessingResponse:
      type: object
      description: Order Status Response
      properties:
        status:
          type: string
          description: This indicates the current order status. The value will be 'PROCESSING' in a batch order.
          example: PROCESSING
        orderId:
          type: string
          description: Wpay order identifier (ID). This order ID is used at the end the batch order process when retrievig the ativated cards.
          example: AAN9200073512
        refno:
          type: string
          description: Your unique order reference identifier that was supplied in the request. This identifier is used to retrieve the order status.
          example: aaaa-bbbb-0000-0001
        cancel:
          $ref: '#/components/schemas/cancelObject'
        currency:
          $ref: '#/components/schemas/currencyObject'
        payments:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: svc
      example:
        status: PROCESSING
        orderId: AAN9200073512
        refno: aaaa-bbbb-0000-0001
        cancel:
          allowed: false
          allowedWithIn: 15
        currency:
          code: NZD
          numericCode: '554'
          symbol: NZ$
        payments:
        - code: svc
    cardPurchaseObject:
      type: object
      required:
      - sku
      - price
      - qty
      - currency
      properties:
        sku:
          type: string
          description: The gift card identifier (SKU). The list of gift cards you may order will be predefined and shared during the onboarding process.
          example: WOOHOO
        price:
          type: number
          description: The currency amount to load onto the gift card.
          example: 5
        qty:
          type: number
          description: The number of gift cards you wish to order with this SKU and price combination.
          example: 1
        currency:
          type: string
          description: Use 036 for AUD currency. The full list of valid codes is defined at  https://en.wikipedia.org/wiki/ISO_4217
          minLength: 3
          maxLength: 3
          example: '036'
    physicalCardActivateCardObject:
      type: object
      allOf:
      - $ref: '#/components/schemas/cardPurchaseObject'
      - type: object
        properties:
          qty:
            description: Only 1 physical card may be activated per API call.
            type: number
            default: 1
            example: 1
          cardNumber:
            type: string
            description: The card number of the gift card to be activated
            example: '7998892010000285'
          trackData:
            type: string
            description: The trackData or barcode of the gift card
            example: '7998892010000285'
    PhysicalOrderRequest:
      required:
      - refno
      - syncOnly
      type: object
      properties:
        payments:
          $ref: '#/components/schemas/paymentsObject'
        products:
          type: array
          description: Only one single physical card may be activated per API call.
          minItems: 1
          maxItems: 1
          items:
            required:
            - cardNumber
            $ref: '#/components/schemas/physicalCardActivateCardObject'
        refno:
          type: string
          description: A unique order reference identifier you generate and supply.
          maxLength: 55
          example: aaaa-bbbb-0000-0001
        outletName:
          type: string
          description: The outlet name from where the gift card activation is triggered. This is required for partners who have multiple outlets
          example: W2773 - SydneyOutlet
        orderType:
          type: string
          description: Physical card activations require the value 'FULFILLMENT_BY_SELLER'.
          default: FULFILLMENT_BY_SELLER
          example: FULFILLMENT_BY_SELLER
        syncOnly:
          type: boolean
          description: Always supply the value of `true`
          default: true
          example: true
      description: The JSON request structure of the Physical card activation Order endpoint.
      example:
        payments:
        - code: svc
          amount: 1000
        refno: aaaa-bbbb-0000-0001
        products:
        - sku: EGVGBTNS001
          price: 1000
          qty: 1
          currency: '036'
          cardNumber: '7998892010000285'
          trackData: ;7998892010000285=000000101068785?
        outletName: W2773-SydneyOutlet
        syncOnly: true
    BusinessLogicErrorResponse:
      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: '5313'
        errorMessage:
          type: string
          description: The error message
          example: Duplicate reference number provided
        messages:
          type: array
          items:
            type: string
        additionalTxnFields:
          type: object
          properties:
            responseCode:
              type: number
              example: 10004
      example:
        httpStatusCode: 400
        errorCode: '5313'
        errorMessage: Duplicate reference number provided
        messages: []
        additionalTxnFields:
          responseCode: 10004
    paymentsObject:
      description: The account the gift card amounts will be deducted from. Requires one single element to indicate the payment will be made using the SVA.
      type: array
      minItems: 1
      maxItems: 1
      items:
        required:
        - code
        - amount
        type: object
        properties:
          code:
            type: string
            description: Always use the code 'svc'.
            example: svc
            default: svc
            enum:
            - svc
          amount:
            type: number
            description: The payment amount for the order. This value must match the sum of 'price' times 'qty' for all cards in this order.
            example: 5
    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'
    cancelObject:
      type: object
      description: This field is unused.
      properties:
        allowed:
          type: boolean
          example: false
        allowedWithIn:
          type: number
          example: 15
    PhysicalOrderResponse:
      description: Phisical gift card activation response.
      $ref: '#/components/schemas/OrderProcessingResponse'
      example:
        status: COMPLETE
        orderId: AAN9200073512
        refno: aaaa-bbbb-0000-0001
        cancel:
          allowed: false
        currency:
          code: AUD
          numericCode: '036'
          symbol: $
        payments:
        - code: svc
    currencyObject:
      type: object
      description: Contains details about the gift card currency.
      properties:
        code:
          type: string
          description: Currency code
          example: AUD
        numericCode:
          type: string
          minLength: 3
          maxLength: 3
          description: Currency numeric code as per https://en.wikipedia.org/wiki/ISO_4217
          example: '036'
        symbol:
          type: string
          description: Currency symbol
          example: $
  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