Woolworths Group Void API

openapi: 3.2.0
info:
  title: Wpay Cards Connect Void API
  description: This swagger documents the APIs to integrate into Cards Connect. These APIs implement standard payment message types to allow payment providers to post financial transactions.
  contact:
    name: Wpay
    url: https://www.wpay.io
  version: v1
tags:
- name: Void
  description: A void reverses an un-captured authorization. The action informs the issuing bank to release the lock of funds that was created by an authorization request.
paths:
  /api/v1/transactions/{transactionId}/voids/{voidId}:
    get:
      tags:
      - Void
      summary: Get a void request
      description: This endpoint is used to get a void request for a given authorization.
      operationId: GetVoidAsync
      parameters:
      - name: transactionId
        in: path
        description: Id of the transaction that has the void you are interested in.
        required: true
        schema:
          type: string
      - name: voidId
        in: path
        description: Id of the void you want to fetch the details of.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get void request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpVoidResponse'
              example:
                void:
                  id: 816fff12-1190-4984-80ec-e4a970f244c4
                  amount: 1499
                  outcome: Accepted
                  responseCode: null
                  responseDescription: null
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: 0f569278-9784-4241-ad35-08ac61f7cd38
                reconciliationId: e5a05fc0-5b14-4306-8de3-b794c0971aa4
                permittedActionHints: []
                browserViewLink: https://portal-link/todo
        '401':
          description: The user is not authorized to make this request.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - Void
      summary: Create a void request
      description: This endpoint is used to void an authorization request.
      operationId: VoidAuthorizationAsync
      parameters:
      - name: transactionId
        in: path
        description: The transaction id that was provided during the authorization request.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      - name: voidId
        in: path
        description: A unique identifier for the void operation. The identifier must be unique per transaction.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      requestBody:
        description: The void request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CnpVoidRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CnpVoidRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CnpVoidRequest'
        required: true
      responses:
        '201':
          description: The void request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpVoidResponse'
              example:
                void:
                  id: 548ae391-4610-4ed1-8d3f-871a51a05d52
                  amount: 1499
                  outcome: Accepted
                  responseCode: null
                  responseDescription: null
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: fca8f852-5087-4dfb-bd11-b318a69b759e
                reconciliationId: 404f768f-93e0-4d08-8f2c-8537c05d3c44
                permittedActionHints: []
                browserViewLink: https://portal-link/todo
        '401':
          description: The user is not authorized to make this request.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/v1/transactions/{transactionId}/voids:
    get:
      tags:
      - Void
      summary: Get all void records for a transaction
      description: This endpoint is used to get all void requests for a given authorization.
      operationId: GetVoidsAsync
      parameters:
      - name: transactionId
        in: path
        description: Id of the transaction that has the void you are interested in.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get void requests was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpVoidsResponse'
              example:
                voids:
                - id: fd01cc2e-55dc-45a9-8dba-0842a01d90da
                  amount: 1499
                  outcome: Accepted
                  responseCode: null
                  responseDescription: null
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                - id: 2cc3de2a-f3b0-42ee-b407-4c4aaec61d64
                  amount: 2211
                  outcome: Accepted
                  responseCode: null
                  responseDescription: null
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: 37b0fc67-f5c5-42e8-9b06-c68e371d7fa2
                reconciliationId: 15b58189-666a-41c5-9614-c3989445f7b2
                permittedActionHints: []
                browserViewLink: https://portal-link/todo
        '401':
          description: The user is not authorized to make this request.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    CnpVoidRequest:
      type: object
      properties:
        webhookUrl:
          type:
          - string
          - 'null'
          description: Webhook URL that will be called by Cards Connect to deliver notifications about the status of the transaction.
      additionalProperties: false
    SchemeExtendedResponseData:
      type: object
      properties:
        mastercardTransactionLinkId:
          type:
          - string
          - 'null'
          description: Mastercard Transaction Link Identifier (TLID) used by Mastercard to link different events in the lifecycle of a transaction.
      additionalProperties: false
    TransactionOutcome:
      enum:
      - Accepted
      - InProgress
      - InProgressDelayed
      - Succeeded
      - Declined
      - BusyFailing
      - BusyFailingDelayed
      - Failed
      - Ruined
      type: string
    PermittedTransactionOperationHint:
      enum:
      - Capture
      - Void
      - Refund
      type: string
      description: 'Hints for transaction operation permitted for the given transaction state '
    CnpVoidResponse:
      required:
      - browserViewLink
      - permittedActionHints
      - reconciliationId
      - transactionId
      - void
      type: object
      properties:
        transactionId:
          type: string
          description: The unique identifier of the transaction passed during the authorization request
        reconciliationId:
          type: string
          description: Reconciliation id passed during the authorization request
        permittedActionHints:
          type: array
          items:
            $ref: '#/components/schemas/PermittedTransactionOperationHint'
          description: Provides hints of permitted actions based on the state of the transaction
        browserViewLink:
          type:
          - string
          - 'null'
          description: A direct link for viewing the transaction in the Cards Connect Portal for end-users.
        void:
          $ref: '#/components/schemas/VoidResponse'
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    CnpVoidsResponse:
      required:
      - browserViewLink
      - permittedActionHints
      - reconciliationId
      - transactionId
      - voids
      type: object
      properties:
        transactionId:
          type: string
          description: The unique identifier of the transaction passed during the authorization request
        reconciliationId:
          type: string
          description: Reconciliation id passed during the authorization request
        permittedActionHints:
          type: array
          items:
            $ref: '#/components/schemas/PermittedTransactionOperationHint'
          description: Provides hints of permitted actions based on the state of the transaction
        browserViewLink:
          type:
          - string
          - 'null'
          description: A direct link for viewing the transaction in the Cards Connect Portal for end-users.
        voids:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VoidResponse'
      additionalProperties: false
    VoidResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the void operation, as passed during the void request
        amount:
          type: integer
          description: The amount voided by the void request
          format: int32
        outcome:
          $ref: '#/components/schemas/TransactionOutcome'
        responseCode:
          type:
          - string
          - 'null'
          description: Null for void operation
        responseDescription:
          type:
          - string
          - 'null'
          description: Null for void operation
        createdAt:
          type: string
          description: Date and time when this void was created in our system
          format: date-time
        schemeExtendedResponseData:
          $ref: '#/components/schemas/SchemeExtendedResponseData'
      additionalProperties: false
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/cardsconnect/reference/captureauthorizationasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/createaccountstatusinquiryasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/createauthorizationasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getaccountstatusinquiryasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getauthorizationasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getcaptureasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getcapturesasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getcredentialpublickeyasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getpublickeyasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getpublickeybyidasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getrefundasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getrefundsasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/gettransactionasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getvoidasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/getvoidsasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/put_api-v1-keys-credential-rotate-to-keyid.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/refundauthorizationasync.md
  - https://developerhub.wpay.com.au/cardsconnect/reference/voidauthorizationasync.md