• Documentation
  • API Reference
  • Documentation
  • API Reference
Expand All Collapse All
< BACK TO HOME
  • Online Payments
    • Introduction
    • Choosing an Integration Method
    • Payment Scenarios
    • Flow Diagrams
  • Accept Payment
    • Payment Page (Cashier)
      • Quick Start
      • Input Parameters
      • Output Parameters
      • Payment Page Features
      • Cashier
        • Cashier Events Guide
        • Cashier Features
        • Withdrawal Guide
    • Web SDK
      • Quick Start
      • Nuvei Fields
        • Styling
      • Additional Functions
      • APM Payments
      • Tokenization-Only Flow
      • Scenarios
      • Using ReactJS
        • Full Samples
        • Sandbox Examples
      • FAQs
    • Simply Connect
      • Quick Start
        • UI Customization
        • Payment Customization
        • Advanced Controls
        • Simply Connect Examples
      • Server-to-Server
        • REST 1.0
        • Server SDKs
          • Java SDK
          • .NET SDK
          • PHP SDK
          • Node.JS SDK
      • Mobile SDKs (Beta Release)
        • Android Mobile SDK (Beta Release)
        • iOS Mobile SDK (Beta Release)
      • Marketplaces
      • Self Track
    • Features
      • Authentication
      • Financial Operations
        • Refund
        • Void
        • Auth and Settle
        • Partial Approval
        • Currency Conversion: DCC and MCP
          • Multiple Currency Pricing (MCP)
          • Dynamic Currency Conversion (DCC)
            • DCC in Cashier or Payment Page
            • DCC in REST API Workflows
            • DCC in Web SDK Workflows
        • Payout
        • AFT (Account Funding Transactions)
      • Card Operations
        • Card-on-File
        • PCI and Tokenization
        • Zero-Authorization
        • Merchant-Initiated Transactions (MIT)
        • Blocking Cards
      • Subscriptions (Rebilling)
      • 3D-Secure
        • 3D-Secure Explained
        • 3DS Implementations
          • 3DS MPI-Only Web SDK
          • 3DS MPI-Only REST
          • 3DS External MPI
          • 3DS Responses
          • Challenges and Exemptions
        • 3DS Functions
          • 3D-Secure Fingerprinting
          • 3D-Secure Authentication Challenge
      • Addendums
        • Airline
          • External Authorization
    • Integration
      • Testing Cards, APIs and APMs
        • Testing Cards
        • Testing APMs
        • Testing APIs with Postman
      • Response Handling
      • Webhooks (DMNs)
        • Payment Transaction Requests
        • Control Panel Events API
      • Payment Facilitators (PayFac)
    • Additional Links
      • FAQs
      • API Reference
      • Release Notes
      • Country and Currency Codes

    Void

    The /voidTransaction method is used to cancel Sales / Credits / APM requests/transactions, during the short time window between submitting the Sale/Credit/APM request and the moment that the Sale/Credit/APM transmission is passed. For example, in the best-case scenario, voiding may only be possible up to 24 hours after submitting the Sale/Credit request.

    The void request currency and amountneeds to match that of the original Sale/Credit/APM transaction.

    When sending a /voidTransaction request, you must provide the relatedTransactionId (which is the original Sale/Credit/APM transactionId) and the authCode.

    You can use Postman to run a full “Simple Auth-Settle scenario and Void” workflow simulation in the Nuvei sandbox environment.

    To install Postman and the relevant simulation collection, follow the steps in the Testing APIs with Postman topic.

    Example /voidTransaction Request
    {
        "merchantId": "<your merchantId>",
        "merchantSiteId": "<your merchantSiteId>",
        "relatedTransactionId": "<transactionId returned from /payment>",
        "amount": "200",
        "currency": "USD",
        "urlDetails": {
         "notificationUrl": "<notificationURL>"
        },
        "clientRequestId": "<unique request ID in merchant system>",
        "clientUniqueId": "<unique transaction ID in merchant system>",
        "timeStamp": "<YYYYMMDDHHmmss>",
        "checksum": "<calculated checksum>"
    }
    //Initialize the SDK (see https://docs.nuvei.com/?p=53233)
    
    <?php
    //voidTransaction
    $voidResponse = $safeCharge->getPaymentService()->voidTransaction([
        'clientUniqueId'          => '<unique transaction ID in merchant system>',
        'amount'                  => '200',
        'currency'                => 'USD',
        'relatedTransactionId'    => '<transactionId returned from /payment>',
    ]);
    ?>
    //Initialize the SDK (see https://docs.nuvei.com/?p=29433)
    
    {
        String clientUniqueId = "<unique transaction ID in merchant system>";
        String clientRequestId = "<unique request ID in merchant system>";
        String currency = "USD";
        String amount = "200";
        String relatedTransactionId = "<transactionId returned from /payment>";
    
        Safecharge safecharge = new Safecharge();
        SafechargeResponse response = safecharge.voidTransaction(clientRequestId, relatedTransactionId, amount, currency, null, clientUniqueId, null, null, null, null, null, null);
    }
    //Initialize the SDK (see https://docs.nuvei.com/?p=48413)
    
    var response = safecharge.VoidTransaction(
        "US",
        "200",
        relatedTransactionId: "<transactionId returned from /payment>",
        clientRequestId: "<unique request ID in merchant system>",
        clientUniqueId: "<unique transaction ID in merchant system>");
    //Initialize the SDK (see https://docs.nuvei.com/?p=53443)
    
    safecharge.paymentService.voidTransaction({
        clientRequestId     : "<unique request ID in merchant system>",
        clientUniqueId      : "<unique transaction ID in merchant system>,
        amount              : "200",
        currency            : "USD",
        relatedTransactionId: "<transactionId returned from /payment>",
    }, function (stlErr, stlRes, reqData) {
        console.log(stlErr, stlRes);
    
    });
    Example /voidTransaction Response
    {
        "transactionId": "1110000000004320759",
        "externalTransactionId": "",
        "gwErrorCode": 0,
        "gwExtendedErrorCode": 0,
        "transactionStatus": "APPROVED",
        "authCode": "111454",
        "clientUniqueId": "20200307173638",
        "CVV2Reply": "",
        "AVSCode": "",
        "transactionType": "VoidCredit",
        "customData": "",
        "acquirerId": "19",
        "bin": "400002",
        "last4Digits": "8694",
        "ccCardNumber": "4****8694",
        "ccExpMonth": "09",
        "ccExpYear": "21",
        "cardType": "Credit",
        "cardBrand": "VISA",
        "v2supported": "false",
        "internalRequestId": 178720058,
        "status": "SUCCESS",
        "errCode": 0,
        "reason": "",
        "merchantId": "4960497427404081578",
        "merchantSiteId": "197846",
        "version": "1.0",
        "clientRequestId": "20200307173638"
    }
    2023 Nuvei. All rights reserved.