Woolworths Group Capture API

openapi: 3.2.0
info:
  title: Wpay Cards Connect Capture 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: Capture
  description: Captures are sent after an authorization. This request finalizes the transaction, and on approval the reserved funds are transferred from the cardholder’s account to the merchant’s account.
paths:
  /api/v1/transactions/{transactionId}/captures/{captureId}:
    put:
      tags:
      - Capture
      summary: Create a capture request
      description: This endpoint is used to create a new capture request.
      operationId: CaptureAuthorizationAsync
      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: captureId
        in: path
        description: A unique identifier for the capture operation. The identifier must be unique per transaction.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      requestBody:
        description: The capture request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CnpCaptureRequest'
            examples:
              Basic Capture Request:
                summary: Basic Capture Request
                value:
                  amount: 1499
                  webhookUrl: null
          text/json:
            schema:
              $ref: '#/components/schemas/CnpCaptureRequest'
            examples:
              Basic Capture Request:
                summary: Basic Capture Request
                value:
                  amount: 1499
                  webhookUrl: null
          application/*+json:
            schema:
              $ref: '#/components/schemas/CnpCaptureRequest'
            examples:
              Basic Capture Request:
                summary: Basic Capture Request
                value:
                  amount: 1499
                  webhookUrl: null
        required: true
      responses:
        '201':
          description: The capture request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpCaptureResponse'
              example:
                capture:
                  id: f6af5c10-accb-48dc-96de-371d87aa5d0c
                  amount: 1499
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: 31b3a211-7767-44c7-bec1-9fab2f83bfe8
                reconciliationId: 982bba2b-9a0b-421e-8ca2-9ff8a9606816
                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'
    get:
      tags:
      - Capture
      summary: Get a capture request
      description: This endpoint is used to get a capture request.
      operationId: GetCaptureAsync
      parameters:
      - name: transactionId
        in: path
        description: The transaction id that was provided during the authorization request.
        required: true
        schema:
          type: string
      - name: captureId
        in: path
        description: The unique identifier that was provided during the capture request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get capture request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpCaptureResponse'
              example:
                capture:
                  id: c2caf1ed-c1b8-44d2-a3c5-30a21af8beec
                  amount: 1499
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: fc48e5fc-f6a7-4e43-bed9-4ed72a7ba07d
                reconciliationId: fc9ebc98-c47f-478f-93d2-0f3459dd57f4
                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}/captures:
    get:
      tags:
      - Capture
      summary: Get all capture records for a transaction
      description: This endpoint is used to get all capture requests for a given authorization.
      operationId: GetCapturesAsync
      parameters:
      - name: transactionId
        in: path
        description: The transaction id that was provided during the capture request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get capture requests was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/CnpCaptureResponse'
              example:
                captures:
                - id: be9ea7d2-1d19-4243-9fdb-60dae9155d4f
                  amount: 1000
                  outcome: Accepted
                  responseCode: '00'
                  responseDescription: Approved or completed
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                - id: 5fb66bfb-32ae-435d-b2f8-05350a78e74a
                  amount: 1499
                  outcome: Declined
                  responseCode: '34'
                  responseDescription: Suspected fraud
                  createdAt: '2026-01-12T03:59:36Z'
                  schemeExtendedResponseData: null
                transactionId: e8bb7d88-acc9-432b-bee7-060c83225b05
                reconciliationId: 5154c164-da44-416c-ac5d-747a9c000852
                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:
    CnpCaptureRequest:
      type: object
      properties:
        amount:
          maximum: 99999999
          minimum: 1
          type: integer
          description: Amount of the capture operation 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
    CaptureResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the capture operation, as passed during the capture request.
        amount:
          type: integer
          description: Amount of the capture operation in cents as it was provided in the request.
          format: int32
        outcome:
          $ref: '#/components/schemas/TransactionOutcome'
        responseCode:
          type:
          - string
          - 'null'
          description: Null for capture operation.
        responseDescription:
          type:
          - string
          - 'null'
          description: Null for capture operation.
        createdAt:
          type: string
          description: Date and time when this capture was created in our system.
          format: date-time
        schemeExtendedResponseData:
          $ref: '#/components/schemas/SchemeExtendedResponseData'
      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 '
    CnpCaptureResponse:
      required:
      - browserViewLink
      - capture
      - permittedActionHints
      - reconciliationId
      - 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.
        capture:
          $ref: '#/components/schemas/CaptureResponse'
      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: {}
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