ProvisioningEOS APIs
Provisioning

Account Verification

This section outlines the Account Verification process within Vortex, focusing on utilizing zero dollar transactions to confirm the activity and validity of a customer's payment account. It serves as a critical preliminary step for merchants to securely and efficiently validate accounts before processing payments.

Suggest Edits

👍

Required Fields

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

Account verification

"Account Verification" transactions are designed to validate a customer's payment method without charging any amount. These transactions check that the card is active and can be used for future payments. This is particularly useful for setting up new payment methods or verifying account details for recurring billing.

Use Cases

  • New Customer Onboarding: Verifying payment details as customers add their payment methods to the system.
  • Recurring Payments Setup: Before setting up subscriptions or any recurring payment plans, ensuring the customer's account is active.
  • Updating Payment Details: Verifying new or updated payment methods provided by customers.

Example

Zero Dollar Authentication

Request body

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "700535928447888",
      "transactionType": "Authorization",
      "totalAmount": 0.0,
      "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
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S3_1"
}

Response Body

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "700535928447888",
      "transactionType": "Authorization",
      "totalAmount": 0.0,
      "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
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S3_1"
}

Failed Scenarios

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

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

  • Inactive or Invalid Account: The card or account number provided does not exist, is not active, or has been flagged for security reasons.
  • Technical Issues: Failures in the Vortex system or communication errors with the banking network can prevent successful verification.
  • Incorrect Account Details: Errors in the card number, expiration date, or other account details can lead to failed verification attempts.

Implementation Notes

When initiating an account verification transaction, ensure all customer account details are accurately entered to avoid errors. It's important to communicate the purpose and outcome of these verification transactions to customers, especially in the event of a failure, to reassure them that no charges will be made for these checks.

Updated over 1 year ago