Sale

A Sale transaction in Vortex Global Payments is a single-step operation that both authorizes and captures funds from a customer’s payment method in one call. This is the recommended flow for straightforward purchases where no delay between authorization and settlement is needed.

Prerequisites & Limitations

merchant.processor.name must be "priority".
currencyCode must be "CAD" (Canadian Dollars).
totalAmount must be greater than 0.50.
A valid globalAccountId must be included under the merchant block.
For surcharge support:
- Only Visa and Mastercard are eligible.
- The surcharge must not exceed 2.4% in Canada.

In this guide, you’ll find:

How to submit a standard Sale transaction using the Vortex API.
How to add a surcharge amount (Visa/Mastercard only).
How to interpret the response payloads.

Sale Request

Standard Sale Payload

{
  "ecom": false,
  "moto": false,
  "recurring": true,
  "externalId": "some-external-id",
  "transactionType": "sale",
  "totalAmount": 100.24,
  "currencyCode": "CAD",
  "merchant": {
    "name": "PPS Engineering UAT 2",
    "sic": "3501",
    "number": "518089240725465",
    "processor": {
      "name": "priority"
    },
    "globalAccountId": "acct_global-account-id"
  },
  "account": {
    "form": "plastic",
    "expiry": "2027-12",
    "number": "4242424242424242"
  },
  "device": {},
  "customer": {
    "address": {
      "street1": "2001 Westside",
      "city": "Alpharetta",
      "state": "GA",
      "postalCode": "30004"
    }
  }
}

Sale Response

{
  "reference": "pi_3RQaQMKX2PidZXm21IiamEIc",
  "status": "succeeded",
  "approved": true,
  "declined": false,
  "message": "Approved",
  "requiredActions": "none",
  "totalAmount": 100.24,
  "requestedAmount": 100.24,
  "surchargeAmount": 0,
  "code": 0,
  "authCode": null,
  "authorization": {
    "avsChecks": {
      "addressLine1": true,
      "postalCode": true,
      "cvc": false
    },
    "network": {
      "adviceCode": null,
      "networkAdviceCode": null,
      "networkStatus": "approved_by_network"
    }
  },
  "cardType": "Discover",
  "network": "discover",
  "cardBin": {
    "type": "",
    "bank": {
      "www": "",
      "name": "",
      "phone": ""
    },
    "bin": "60111111",
    "brand": "DISCOVER",
    "country": {
      "iso": "840",
      "info": "",
      "name": "United States",
      "abbreviation2": "US",
      "abbreviation3": "USA"
    },
    "id": "60111111",
    "source": "pci.bindb.com",
    "level": "",
    "prepaid": null,
    "reloadable": null,
    "business": null,
    "regulated": false
  },
  "accountNumberMask": "1117",
  "id": "9BTISpww+C06ZlAICSU9KA==",
  "meta": {
    "id": "9BTISpww+C06ZlAICSU9KA==",
    "externalId": "1747686997864",
    "received": "2025-05-19T20:36:38.065Z",
    "tenantId": "A1A9550E-830C-474E-9836-DFD4DB492BC0",
    "tenantName": "Test Tenant",
    "replicationGroup": "qa",
    "virtualEnv": "qa-atl",
    "originatingInstance": "natl",
    "environment": "default"
  }
}

Sale with Surcharge

Payload with Surcharge

Surcharges can be applied for Visa and Mastercard transactions only. The surcharge amount must not exceed 2.4% of the total in Canada.

{
  "ecom": false,
  "moto": false,
  "recurring": true,
  "externalId": "some-external-id",
  "transactionType": "sale",
  "totalAmount": 102.4,
  "surchargeAmount": 2.4,
  "currencyCode": "CAD",
  "merchant": {
    "name": "PPS Engineering UAT 2",
    "sic": "3501",
    "number": "518089240725465",
    "processor": {
      "name": "priority"
    },
    "globalAccountId": "acct_global-account-id"
  },
  "account": {
    "form": "plastic",
    "expiry": "2027-12",
    "number": "4242424242424242"
  },
  "device": {},
  "customer": {
    "address": {
      "street1": "2001 Westside",
      "city": "Alpharetta",
      "state": "GA",
      "postalCode": "30004"
    }
  }
}

Surcharge Sale Response

{
  "reference": "pi_3RQaUKKX2PidZXm21mpquEwb",
  "status": "succeeded",
  "approved": true,
  "declined": false,
  "message": "Approved",
  "requiredActions": "none",
  "totalAmount": 102.4,
  "requestedAmount": 102.4,
  "surchargeAmount": 2.4,
  "code": 0,
  "authCode": null,
  "authorization": {
    "avsChecks": {
      "addressLine1": true,
      "postalCode": true,
      "cvc": false
    },
    "network": {
      "adviceCode": null,
      "networkAdviceCode": null,
      "networkStatus": "approved_by_network"
    }
  },
  "cardType": "Visa",
  "network": "visa",
  "cardBin": {
    "type": "CREDIT",
    "bank": {
      "www": "",
      "name": "STRIPE PAYMENTS UK LIMITED",
      "phone": ""
    },
    "bin": "42424242",
    "brand": "VISA",
    "country": {
      "iso": "826",
      "info": "",
      "name": "United Kingdom",
      "abbreviation2": "GB",
      "abbreviation3": "GBR"
    },
    "id": "42424242",
    "source": "pci.bindb.com",
    "level": "CLASSIC",
    "prepaid": false,
    "reloadable": false,
    "business": false,
    "regulated": false
  },
  "accountNumberMask": "4242",
  "id": "BRdXWTPjA8HLlgEHT2NHJQ==",
  "meta": {
    "id": "BRdXWTPjA8HLlgEHT2NHJQ==",
    "externalId": "1747687244022",
    "received": "2025-05-19T20:40:44.208Z",
    "tenantId": "A1A9550E-830C-474E-9836-DFD4DB492BC0",
    "tenantName": "Test Tenant",
    "replicationGroup": "qa",
    "virtualEnv": "qa-atl",
    "originatingInstance": "natl",
    "environment": "default"
  }
}

---

## Implementation Notes

* Set `transactionType` to `"sale"` for immediate authorization and capture in one step.
* Ensure `merchant.processor.name` is `"priority"` and currency is `"CAD"`.
* Do not submit transactions under `0.51 CAD`, as they will be rejected.
* For recurring transactions, include `"recurring": true`.
* If applying a surcharge, ensure:

  * Card type is Visa or Mastercard.
  * The surcharge does not exceed 2.4%.
  * `surchargeAmount` is included and accurate.