Woolworths Group Refund API

openapi: 3.2.0
info:
  title: Wpay Cards Connect Refund 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: Refund
  description: Refunds are submitted on approved capture transactions. Refunds credit a cardholder’s account.
paths:
  /api/v1/transactions/{transactionId}/refunds/{refundId}:
    get:
      tags:
      - Refund
      summary: Get a refund request
      description: This endpoint is used to get a refund request.
      operationId: GetRefundAsync
      parameters:
      - name: transactionId
        in: path
        description: Id of the transaction that has the refund you are interested in.
        required: true
        schema:
          type: string
      - name: refundId
        in: path
        description: Id of the refund you want to fetch the details of.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get refund request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpRefundResponse'
              example:
                refund:
                  id: 98ba3c67-53de-49c6-9284-dadfe133974c
                  amount: 1499
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: de8a424d-2e09-42d0-b6e2-7ffa6dc1a099
                reconciliationId: b5e9ecff-5f82-4930-a99c-4cf99e0514e2
                permittedActionHints:
                - Refund
                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:
      - Refund
      summary: Create a refund request
      description: This endpoint is used to create a new refund request.
      operationId: RefundAuthorizationAsync
      parameters:
      - name: transactionId
        in: path
        description: Transaction identifier that the refund belongs to.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      - name: refundId
        in: path
        description: A unique identifier for the refund operation. The identifier must be unique per transaction.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CnpRefundRequest'
            examples:
              Basic Refund Request:
                summary: Basic Refund Request
                value:
                  amount: 1499
                  webhookUrl: null
          text/json:
            schema:
              $ref: '#/components/schemas/CnpRefundRequest'
            examples:
              Basic Refund Request:
                summary: Basic Refund Request
                value:
                  amount: 1499
                  webhookUrl: null
          application/*+json:
            schema:
              $ref: '#/components/schemas/CnpRefundRequest'
            examples:
              Basic Refund Request:
                summary: Basic Refund Request
                value:
                  amount: 1499
                  webhookUrl: null
      responses:
        '201':
          description: The refund request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpRefundResponse'
              example:
                refund:
                  id: a9e9ffd1-dc9e-414c-b2fb-94061a48a4d1
                  amount: 1499
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: e6a8169c-850f-4e49-8c00-f3658b161f49
                reconciliationId: a2bdf534-29a6-41ee-8214-3bf8c6c17439
                permittedActionHints:
                - Refund
                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}/refunds:
    get:
      tags:
      - Refund
      summary: Get all refund records for a transaction
      description: This endpoint is used to get all refund requests for a given capture.
      operationId: GetRefundsAsync
      parameters:
      - name: transactionId
        in: path
        description: Id of the transaction that has the refund you are interested in.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get refund requests was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpRefundsResponse'
              example:
                refunds:
                - id: e1053190-0fd1-40ac-91db-e3c72bb9341f
                  amount: 1499
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                - id: 0c8f9490-f4b0-4fa7-a780-9ad6bb87a04c
                  amount: 2211
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: 0b08b98d-af10-433d-9d36-e1da57f69546
                reconciliationId: d9bc7ac2-df76-487b-b8c7-a7632b25f709
                permittedActionHints:
                - Refund
                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:
    CnpRefundResponse:
      required:
      - browserViewLink
      - permittedActionHints
      - reconciliationId
      - refund
      - transactionId
      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.
        refund:
          $ref: '#/components/schemas/RefundResponse'
      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
    CnpRefundsResponse:
      required:
      - browserViewLink
      - permittedActionHints
      - reconciliationId
      - refunds
      - transactionId
      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.
        refunds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RefundResponse'
      additionalProperties: false
    PermittedTransactionOperationHint:
      enum:
      - Capture
      - Void
      - Refund
      type: string
      description: 'Hints for transaction operation permitted for the given transaction state '
    RefundResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the refund operation, as passed during the refund request.
        amount:
          type: integer
          description: Amount of the refund operation in cents as it was provided in the request.
          format: int32
        outcome:
          $ref: '#/components/schemas/TransactionOutcome'
        responseCode:
          type:
          - string
          - 'null'
          description: Response code for the refund as per AS2805 specifications.
        responseDescription:
          type:
          - string
          - 'null'
          description: Response description for the refund as per AS2805 specifications.
        createdAt:
          type: string
          description: Date and time when this refund was created in our system.
          format: date-time
        schemeExtendedResponseData:
          $ref: '#/components/schemas/SchemeExtendedResponseData'
      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: {}
    CnpRefundRequest:
      type: object
      properties:
        amount:
          maximum: 99999999
          minimum: 1
          type: integer
          description: Amount of the transaction in cents. 1499 is $14.99.
          format: int32
        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
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