younifyd
Menu

transactionVoid

Trigger the voiding of an uncaptured authorization transaction.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the transactionVoid action (under Transaction).
  3. Fill in the fields below, then reference the result from later steps as {{transactionvoid.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
mutation TransactionVoid($parentTransactionId: ID!) {
  transactionVoid(parentTransactionId: $parentTransactionId) {
    transaction {
      accountNumber
      amount
      amountRoundingSet {
        presentmentMoney
        shopMoney
      }
      amountSet {
        presentmentMoney
        shopMoney
      }
      amountV2 {
        amount
        currencyCode
      }
      authorizationCode
      authorizationExpiresAt
      createdAt
      currencyExchangeAdjustment {
        adjustment
        finalAmountSet
        id
        originalAmountSet
      }
      device {
        activePaymentSession
        cashDrawer
        id
      }
      errorCode
      fees {
        amount
        flatFee
        flatFeeName
        id
        rate
        rateName
        taxAmount
        type
      }
      formattedGateway
      gateway
      id
      kind
      location {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      manualPaymentGateway
      manuallyCapturable
      maximumRefundable
      maximumRefundableV2 {
        amount
        currencyCode
      }
      multiCapturable
      order {
        additionalFees
        alerts
        app
        attribution
        billingAddress
        billingAddressMatchesShippingAddress
        canMarkAsPaid
        canNotifyCustomer
        cancelReason
        cancellation
        cancelledAt
        capturable
        cartDiscountAmount
        cartDiscountAmountSet
        cartToken
        channel
        channelInformation
        checkoutToken
        clientIp
        closed
        closedAt
        confirmationNumber
        confirmed
        createdAt
        currencyCode
        currentCartDiscountAmountSet
        currentShippingPriceSet
        currentSubtotalLineItemsQuantity
        currentSubtotalPriceSet
        currentTaxLines
        currentTotalAdditionalFeesSet
        currentTotalDiscountsSet
        currentTotalDutiesSet
        currentTotalPriceSet
        currentTotalTaxSet
        currentTotalWeight
        customAttributes
        customer
        customerAcceptsMarketing
        customerJourney
        customerJourneySummary
        customerLocale
        discountCode
        discountCodes
        displayAddress
        displayFinancialStatus
        displayFulfillmentStatus
        disputes
        dutiesIncluded
        edited
        email
        estimatedTaxes
        fulfillable
        fulfillmentsCount
        fullyPaid
        hasTimelineComment
        id
        landingPageDisplayText
        landingPageUrl
        legacyResourceId
        merchantBusinessEntity
        merchantEditable
        merchantEditableErrors
        merchantOfRecordApp
        name
        netPayment
        netPaymentSet
        note
        number
        originalTotalAdditionalFeesSet
        originalTotalDutiesSet
        originalTotalPriceSet
        paymentCollectionDetails
        paymentGatewayNames
        paymentTerms
        phone
        physicalLocation
        poNumber
        presentmentCurrencyCode
        processedAt
        productNetwork
        publication
        purchasingEntity
        referralCode
        referrerDisplayText
        referrerUrl
        refundDiscrepancySet
        refundable
        registeredSourceUrl
        requiresShipping
        restockable
        retailLocation
        returnStatus
        risk
        riskLevel
        shippingAddress
        shippingLine
        shopifyProtect
        sourceIdentifier
        sourceName
        staffMember
        subtotalLineItemsQuantity
        subtotalPrice
        subtotalPriceSet
        tags
        taxExempt
        taxLines
        taxesIncluded
        test
        totalCapturable
        totalCapturableSet
        totalCashRoundingAdjustment
        totalDiscounts
        totalDiscountsSet
        totalOutstandingSet
        totalPrice
        totalPriceSet
        totalReceived
        totalReceivedSet
        totalRefunded
        totalRefundedSet
        totalRefundedShippingSet
        totalShippingPrice
        totalShippingPriceSet
        totalTax
        totalTaxSet
        totalTipReceived
        totalTipReceivedSet
        totalWeight
        transactionsCount
        unpaid
        updatedAt
      }
      parentTransaction
      paymentDetails
      paymentId
      paymentMethod
      processedAt
      receiptJson
      settlementCurrency
      settlementCurrencyRate
      shopifyPaymentsSet {
        extendedAuthorizationSet
        refundSet
      }
      status
      test
      totalUnsettled
      totalUnsettledSet {
        presentmentMoney
        shopMoney
      }
      totalUnsettledV2 {
        amount
        currencyCode
      }
      user {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

parentTransactionIdstringrequired

An uncaptured authorization transaction.

json
{
  "parentTransactionId": "string"
}

Response

Read the result with {{transactionvoid.response.data.data.transactionVoid}}. If the API returns errors, the step fails and they are at {{transactionvoid.response.data.errors}}.

transactionobject
accountNumberstring
amountstring
amountRoundingSetobject2 fields
amountSetobject2 fields
amountV2object2 fields
authorizationCodestring
authorizationExpiresAtstring
createdAtstring
currencyExchangeAdjustmentobject4 fields
deviceobject3 fields
errorCodestring

One ofINCORRECT_NUMBERINVALID_NUMBERINVALID_EXPIRY_DATEINVALID_CVCEXPIRED_CARDINCORRECT_CVCINCORRECT_ZIPINCORRECT_ADDRESSINCORRECT_PINCARD_DECLINEDPROCESSING_ERRORCALL_ISSUERPICK_UP_CARDCONFIG_ERRORTEST_MODE_LIVE_CARDUNSUPPORTED_FEATUREGENERIC_ERRORINVALID_COUNTRYINVALID_AMOUNTPAYMENT_METHOD_UNAVAILABLEAMAZON_PAYMENTS_INVALID_PAYMENT_METHODAMAZON_PAYMENTS_MAX_AMOUNT_CHARGEDAMAZON_PAYMENTS_MAX_AMOUNT_REFUNDEDAMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTUREDAMAZON_PAYMENTS_MAX_REFUNDS_PROCESSEDAMAZON_PAYMENTS_ORDER_REFERENCE_CANCELEDAMAZON_PAYMENTS_STALEAMOUNT_TOO_LARGEAMOUNT_TOO_SMALLAUTHENTICATION_FAILEDAUTHENTICATION_REQUIREDCANCELLED_PAYMENTCARD_TESTINGDO_NOT_HONORFRAUD_SUSPECTEDINSUFFICIENT_FUNDSINVALID_CURRENCYINVALID_PAYMENT_METHODINVALID_PURCHASE_TYPEMERCHANT_ACCOUNT_ERROR

feesarray<object>
formattedGatewaystring
gatewaystring
idstring
kindstring

One ofSALECAPTUREAUTHORIZATIONVOIDREFUNDCHANGEEMV_AUTHORIZATIONSUGGESTED_REFUND

locationobject21 fields
manualPaymentGatewayboolean
manuallyCapturableboolean
maximumRefundablestring
maximumRefundableV2object2 fields
multiCapturableboolean
orderobject40 fields
parentTransactionobject

Recursive reference to OrderTransaction, not further expanded.

paymentDetailsobject11 fields

This field can return one of several different object shapes — properties from every possible shape are shown together.

paymentIdstring
paymentMethodstring

One ofVISAMASTERCARDDISCOVERAMERICAN_EXPRESSDINERS_CLUBJCBUNIONPAYELODANKORTMAESTROFORBRUGSFORENINGENPAYPALBOGUSBITCOINLITECOINDOGECOININTERACEFTPOSCARTES_BANCAIRESBANCONTACT

processedAtstring
receiptJsonstring
settlementCurrencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

settlementCurrencyRatestring
shopifyPaymentsSetobject2 fields
statusstring

One ofSUCCESSFAILUREPENDINGERRORAWAITING_RESPONSEUNKNOWN

testboolean
totalUnsettledstring
totalUnsettledSetobject2 fields
totalUnsettledV2object2 fields
userobject13 fields
userErrorsarray<object>
codeobject
fieldobject
messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?