Woolworths Group Account Status Inquiry API

openapi: 3.2.0
info:
  title: Wpay Cards Connect Account Status Inquiry 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: AccountStatusInquiry
  description: 'Account Status Inquiry (ASI) or account verification is a type of authorisation that is done to check

    the validity of the card. From the perspective of the merchant, the only difference between a standard

    CNP authorisation and ASI is the amount, that is set as zero.'
paths:
  /api/v1/account-status-inquiries/{id}:
    put:
      tags:
      - AccountStatusInquiry
      summary: Create an account status inquiry request
      description: This endpoint is used to create a new account status inquiry request.
      operationId: CreateAccountStatusInquiryAsync
      parameters:
      - name: id
        in: path
        description: A unique account status inquiry identifier.
        required: true
        schema:
          pattern: ^[\w\d-]{1,38}$
          type: string
      requestBody:
        description: The account status inquiry request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStatusInquiryRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AccountStatusInquiryRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AccountStatusInquiryRequest'
        required: true
      responses:
        '201':
          description: The account status inquiry request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/AccountStatusInquiryResponse'
              example:
                id: 8524ed89-9600-449e-92de-d23548d50eca
                schemeTraceId: MG11579601152109550115MCC09Y1QW
                createdAt: '2026-01-12T03:59:36Z'
                authResponseId: a17367e4-c283-4bb9-9622-8f2bc47a04fa
                outcome: Accepted
                responseCode: '00'
                responseDescription: Approved or completed
                cvvResponseCode: Match
                avsResponseCode: null
                merchantAdviceCode: DoNotTryAgain
                paymentAccountReference: 93c55f9f-8f5c-48b7-bd3a-813ee47f0d63
                browserViewLink: https://portal-link/todo
                schemeExtendedResponseData: null
        '401':
          description: The user is not authorized to make this request.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    get:
      tags:
      - AccountStatusInquiry
      summary: Get an account status inquiry record
      description: This endpoint is used to get an account status inquiry request.
      operationId: GetAccountStatusInquiryAsync
      parameters:
      - name: id
        in: path
        description: A unique account status inquiry identifier.The identifier must be unique per merchant.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The get account status inquiry request was processed.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/AccountStatusInquiryResponse'
              example:
                id: 79ea192b-2785-4e1b-99ec-b924c9a23b7e
                schemeTraceId: MG11579601152109550115MCC09Y1QW
                createdAt: '2026-01-12T03:59:36Z'
                authResponseId: 0fc25359-55c3-44fd-8b90-6c3949a8397b
                outcome: Accepted
                responseCode: '00'
                responseDescription: Approved or completed
                cvvResponseCode: Match
                avsResponseCode: null
                merchantAdviceCode: DoNotTryAgain
                paymentAccountReference: e91eaa68-3ecf-4302-8a7f-8ec0838c8571
                browserViewLink: https://portal-link/todo
                schemeExtendedResponseData: null
        '401':
          description: The user is not authorized to make this request.
          content:
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    MerchantAdviceCode:
      enum:
      - NewAccountInformationAvailable
      - CannotApproveAtThisTime
      - DoNotTryAgain
      - TokenNotSupportedOrTokenRequirementsAreNotMet
      - StopRecurringPayment
      - RetryAfter1Hour
      - RetryAfter24Hours
      - RetryAfter2Days
      - RetryAfter4Days
      - RetryAfter6Days
      - RetryAfter8Days
      - RetryAfter10Days
      - ConsumerNonReloadablePrepaidCard
      - ConsumerSingleUseVirtualCardNumber
      - ConsumerMultiUseVirtualCardNumber
      type: string
    TransactionOutcome:
      enum:
      - Accepted
      - InProgress
      - InProgressDelayed
      - Succeeded
      - Declined
      - BusyFailing
      - BusyFailingDelayed
      - Failed
      - Ruined
      type: string
    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
    PaymentInstrumentDetails:
      required:
      - cardNumber
      - cardType
      - expirationDate
      type: object
      properties:
        cardType:
          type: string
        cardholderName:
          type:
          - string
          - 'null'
          description: The cardholder’s name.
        cardNumber:
          minLength: 1
          type: string
          description: The 13-19 digit card number (PAN) or a tokenized card number (network token or wallet token), depending on the card type.
          format: credit-card
        expirationDate:
          minLength: 1
          type: string
          description: The expiration date of the card or token, depending on the card type. Formatted MM/YY.
      additionalProperties: false
      description: 'Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API. '
      discriminator:
        propertyName: cardType
        mapping:
          Card: '#/components/schemas/PanCardInformationDetails'
          NetworkToken: '#/components/schemas/NetworkTokenCardDetails'
          ApplePay: '#/components/schemas/ApplePayWalletCardDetails'
          GooglePay: '#/components/schemas/GooglePayWalletCardDetails'
    ThreeDSecureDirectoryResponse:
      enum:
      - C
      - Y
      - A
      - N
      - R
      - U
      type: string
    PaymentSource:
      enum:
      - ECommerce
      - Mail
      - Telephone
      - Recurring
      - Installment
      - CardOnFile
      type: string
      description: The source of the transaction. Default value is ECommerce
    CvvResponseCode:
      enum:
      - Match
      - NoMatch
      - NotProvided
      - Unavailable
      - Unknown
      type: string
    PanCardInformationDetails:
      required:
      - cardType
      allOf:
      - $ref: '#/components/schemas/PaymentInstrumentDetails'
      - type: object
        properties:
          cvv:
            type:
            - string
            - 'null'
            description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.
        additionalProperties: false
      properties:
        cardType:
          title: Card
          enum:
          - Card
          type: string
          description: Always `Card`
          default: Card
          example: Card
      description: PAN card details used for this transaction.
    NetworkTokenCardDetails:
      required:
      - cardType
      allOf:
      - $ref: '#/components/schemas/PaymentInstrumentDetails'
      - type: object
        properties:
          cvv:
            type:
            - string
            - 'null'
            description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.
          tokenRequestorId:
            type:
            - string
            - 'null'
            description: Numeric string up to 12 digits to identify the system that requested the token.
          tokenCryptogram:
            maxLength: 64
            minLength: 0
            type:
            - string
            - 'null'
            description: A one-time cryptographic value used to ensure that the token is authorized for the transaction.If provided, this value must be standard Base64-encoded string up to 64 characters long.
            format: byte
        additionalProperties: false
      properties:
        cardType:
          title: NetworkToken
          enum:
          - NetworkToken
          type: string
          description: Always `NetworkToken`
          default: NetworkToken
          example: NetworkToken
      description: Network token details used for this transaction.
    AccountStatusInquiryRequest:
      required:
      - cardDetailsEncrypted
      - reconciliationId
      type: object
      properties:
        reconciliationId:
          maxLength: 64
          minLength: 1
          type: string
          description: An identifier that may be used to link authorization with subsequent operations for reconciliation purpose.
        paymentSource:
          $ref: '#/components/schemas/PaymentSource'
        cardDetails:
          oneOf:
          - $ref: '#/components/schemas/PanCardInformationDetails'
          - $ref: '#/components/schemas/NetworkTokenCardDetails'
          - $ref: '#/components/schemas/ApplePayWalletCardDetails'
          - $ref: '#/components/schemas/GooglePayWalletCardDetails'
          description: 'Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API. '
        cardDetailsEncrypted:
          minLength: 1
          type: string
          description: This field contains the fields from CardDetails encrypted using the JWE technique specified in the encryption guide.
        webhookUrl:
          type:
          - string
          - 'null'
          description: Webhook URL that will be called by Cards Connect to deliver notifications about the status of the transaction.
        threeDSecureData:
          $ref: '#/components/schemas/ThreeDSecureData'
        threeDSecureDataEncrypted:
          type:
          - string
          - 'null'
          description: This field contains the fields from ThreeDSecureData encrypted using the JWE technique specified in the encryption guide.
      additionalProperties: false
    ThreeDSecureAuthenticationResponse:
      enum:
      - Y
      - N
      - U
      - A
      - R
      type: string
    ThreeDSecureData:
      type: object
      properties:
        version:
          type:
          - string
          - 'null'
          description: 3D Secure version used during the transaction
        cavv:
          type:
          - string
          - 'null'
          description: Cardholder authentication values generated for the transaction
        eci:
          type:
          - string
          - 'null'
          description: Electronic commerce indicator
        directoryResponse:
          $ref: '#/components/schemas/ThreeDSecureDirectoryResponse'
        authenticationResponse:
          $ref: '#/components/schemas/ThreeDSecureAuthenticationResponse'
        directoryTransactionId:
          type:
          - string
          - 'null'
          description: Directory server transaction identifier
        xid:
          type:
          - string
          - 'null'
          description: Unique transaction identifier
      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: {}
    AccountStatusInquiryResponse:
      required:
      - browserViewLink
      - id
      type: object
      properties:
        id:
          type: string
          description: Transaction identifier that was passed in the request path.
        schemeTraceId:
          type:
          - string
          - 'null'
          description: Identifier generated by the scheme. E.g. Visa Transaction Identifier, or MasterCard Trace ID.
        createdAt:
          type: string
          description: Date and time when this transaction was created in our system.
          format: date-time
        authResponseId:
          type:
          - string
          - 'null'
          description: Authorization response id received from the issuer. Also known as an "Auth No".
        outcome:
          $ref: '#/components/schemas/TransactionOutcome'
        responseCode:
          type:
          - string
          - 'null'
          description: Response code for the authorization as per AS2805 specifications.
        responseDescription:
          type:
          - string
          - 'null'
          description: Response description for the authorization as per AS2805 specifications.
        cvvResponseCode:
          $ref: '#/components/schemas/CvvResponseCode'
        avsResponseCode:
          type:
          - string
          - 'null'
          description: Address verification service response code, available if a validation was done.
        merchantAdviceCode:
          $ref: '#/components/schemas/MerchantAdviceCode'
        paymentAccountReference:
          type:
          - string
          - 'null'
          description: A non-financial reference value assigned to a unique PAN that links the payment account represented by that PAN to all of its related tokens.
        browserViewLink:
          type:
          - string
          - 'null'
          description: A direct link for viewing the transaction in the Cards Connect Portal for end-users.
        schemeExtendedResponseData:
          $ref: '#/components/schemas/SchemeExtendedResponseData'
      additionalProperties: false
    ApplePayWalletCardDetails:
      required:
      - cardType
      allOf:
      - $ref: '#/components/schemas/PaymentInstrumentDetails'
      - required:
        - tokenCryptogram
        type: object
        properties:
          tokenCryptogram:
            maxLength: 64
            minLength: 0
            type: string
            description: A one-time cryptographic value used to ensure that the token is authorized for the transaction.This value must be standard Base64-encoded string up to 64 characters long.
            format: byte
        additionalProperties: false
      properties:
        cardType:
          title: ApplePay
          enum:
          - ApplePay
          type: string
          description: Always `ApplePay`
          default: ApplePay
          example: ApplePay
      description: Apple Pay mobile wallet token details for this transaction.
    GooglePayWalletCardDetails:
      required:
      - cardType
      allOf:
      - $ref: '#/components/schemas/PaymentInstrumentDetails'
      - required:
        - tokenCryptogram
        type: object
        properties:
          tokenCryptogram:
            maxLength: 64
            minLength: 0
            type: string
            description: A one-time cryptographic value used to ensure that the token is authorized for the transaction.This value must be standard Base64-encoded string up to 64 characters long.
            format: byte
        additionalProperties: false
      properties:
        cardType:
          title: GooglePay
          enum:
          - GooglePay
          type: string
          description: Always `GooglePay`
          default: GooglePay
          example: GooglePay
      description: Google Pay mobile wallet token details for this transaction.
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