Completion

This page provides an overview of the Completion transaction in Vortex, detailing the process of finalizing an authorized payment and transferring funds from the customer to the merchant.

In this guide, you'll find:

A clear explanation of what a Completion transaction is in Vortex
Use cases for capturing authorizations and handling adjustments
Common reasons for failed Completion transactions and troubleshooting tips

Completion in Vortex

The Completion transaction in Vortex refers to the process of finalizing a previously approved authorization, effectively capturing the funds for a sale. This step is a critical component of the payment lifecycle, transitioning an authorization to a settled state, where the funds are transferred from the customer's account to the merchant's account.

Use Cases

Capture an authorization: Once an authorization is approved, the completion transaction captures the specified amount, confirming the sale and initiating the transfer of funds.
Adjustment for completions: Adjustments may be necessary if the final sale amount differs from the originally authorized amount. In Vortex, such adjustments are managed internally and do not require external updates.

Examples

Create Completion

Body Request

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "425570141719573",
      "transactionType": "SaleCompletion",
      "totalAmount": 40.05,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false,
      "authCode": "PPSca8",
      "originalExternalId": "885059293824598"
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S490_02"
}

Response Body

{
  "code": 200,
  "requestId": "Scenario_Visa_WS0.S490_02",
  "id": "2625b5a6-4c33-420e-b514-107ef54b073d",
  "error": null,
  "value": {
    "authCode": "PPSca8",
    "code": 0,
    "productId": "V",
    "cardType": "Visa",
    "validationCode": "VI73",
    "message": "Approved and completed successfully",
    "transactionId": "050000000019573",
    "network": "visa",
    "reference": "405200908221",
    "authorization": {
      "authorized": false,
      "source": "V",
      "acceptorId": "518089240725465",
      "processingTime": "00:00:00",
      "reversed": false,
      "responseCode": "00",
      "accountCaptureMethod": 1
    },
    "totalAmount": 40.05,
    "approved": true,
    "declined": false,
    "originalAmount": 40.05,
    "cardBin": {
      "country": {
        "iso": "702",
        "name": "Singapore",
        "abbreviation2": "SG",
        "info": "",
        "abbreviation3": "SGP"
      },
      "bank": {
        "phone": "6468 5566",
        "www": "www.hsbc.com.sg",
        "name": "HSBC"
      },
      "business": false,
      "level": "CLASSIC",
      "regulated": false,
      "bin": "47613400",
      "reloadable": false,
      "prepaid": false,
      "id": "47613400",
      "source": "pci.bindb.com",
      "type": "CREDIT",
      "brand": "VISA"
    },
    "lossPrevention": {},
    "aciResponse": "N",
    "requestedAmount": 40.05,
    "id": "8UDIrY4ABFaNij7avcsMSQ==",
    "partial": false,
    "reversed": false
  },
  "class": "response"
}

Implementation Notes

A completion transaction in Vortex requires that the captured authorization is valid and has already been approved.

Merchants need to ensure that the authorizationId they provide aligns with an approved authorization.

If the amount to be captured differs from the originally authorized amount, you must make any necessary adjustments prior to initiating the completion process.

Failed Scenarios

To view all possible error codes for failed transactions, visit our Error Codes page.

Common Reasons for Failure

Authorization not found: The specified authorizationId does not match any existing or valid authorization.
Authorization expired: The authorization expired before the completion attempt. Authorizations have a limited validity period.
Mismatch in amounts: The specified capture amount exceeds the authorized amount and does not account for the necessary adjustment.
Technical issues: System-related errors within Vortex or the merchant's infrastructure can also cause transaction failures.

When a completion transaction fails, merchants must review the error code and accompanying message to determine the root cause.

Depending on the issue, merchants may need to re-initiate the authorization process, adjust the capture request, or contact support for further assistance.