ProvisioningEOS APIs
Provisioning

Completion

This guide details the Completion transaction process within Vortex, focusing on capturing an approved authorization and finalizing the sale. It includes necessary steps for adjustments, settlement of the transaction, and outlines potential failure scenarios for a comprehensive understanding.

Suggest Edits

👍

Required Fields

To get a comprehensive list of fields, please visit our Required Fields dedicated page.

Completion

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 crucial in 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: Following an approved authorization, the completion transaction captures the specified amount, confirming the sale.
  • Adjustment for Completions: Adjustments may be necessary if the final sale amount differs from the originally authorized amount. Note that in Vortex, these adjustments are handled internally and are not sent out.

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

For a completion transaction to be successful in Vortex, it is imperative that the authorization it seeks to capture has been previously approved. Merchants should ensure that the authorizationId provided corresponds to an authorization that is both valid and approved. Adjustments to the authorized amount, if necessary, should have been accounted for prior to this stage.

Failed Scenarios

To get a comprehensive list of Error Codes to help you understand the Failed Scenarios, please visit our Error Codes dedicated page

Completion transactions can fail for several reasons, including but not limited to:

  • Authorization Not Found: The specified authorizationId does not correspond to any existing or valid authorization.
  • Authorization Expired: The authorization has expired by the time the completion attempt is made. Authorizations typically have a limited validity period.
  • Mismatch in Amounts: The amount specified for capture exceeds the amount that was authorized, without proper adjustment authorization.
  • Technical Issues: Failures can also occur due to technical issues within the Vortex system or the merchant's system.

In the event of a failure, it is crucial for the merchant to understand the reason behind the failure (as indicated by the error code and message) and take appropriate action, which may include re-initiating the authorization process or contacting support for assistance.

Updated over 1 year ago