Release NotesPortal GuideAPI Reference
Documentation
  1. Global Payments

Authorization

This guide provides details for running Authorization transactions through Vortex Global Payments, specifically focusing on Priority as the processor and Canadian currency requirements. It includes payload examples, key field requirements, implementation notes, and error handling considerations.

Authorization

In Vortex Global Payments, an Authorization transaction confirms that funds are available on a customer's payment method and reserves them for a future capture. This is the first step in a two-part transaction flow (Authorize → Capture), commonly used in e-commerce and recurring billing scenarios.

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 provided under merchant.
💡

If you intend to support recurring transactions, ensure "recurring": true is present in the request body.

In this guide, you’ll find:

  • How to initiate an authorization for a Canadian transaction
  • Required request fields and expected response structure
  • Tips for successful implementation and error prevention

Authorization sample payload

{
    "ecom":false,
    "moto":false,
    "recurring":true,
    "externalId":"some-external-id",
    "transactionType":"authorization",
    "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"
        }
    }
}

Authorization response

{
  reference: 'pi_3RQaGoKX2PidZXm21cmjOzSD',
  status: 'requires_capture',
  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: '7TyeMAGzCIqajT5UrUaWSQ==',
  meta: {
    id: '7TyeMAGzCIqajT5UrUaWSQ==',
    externalId: '1747686405961',
    received: '2025-05-19T20:26:46.190Z',
    tenantId: 'A1A9550E-830C-474E-9836-DFD4DB492BC0',
    tenantName: 'Test Tenant',
    replicationGroup: 'qa',
    virtualEnv: 'qa-atl',
    originatingInstance: 'natl',
    environment: 'default'
  }
}

Implementation Notes

To successfully run Global Payment Authorization in Vortex, ensure:

  • The merchant.processor.name is exactly set to "priority".
  • The currencyCode is "CAD" to process Canadian Dollar transactions.
  • The totalAmount must be greater than 0.50, as lower amounts are rejected.
  • When recurring billing is used, include "recurring": true in the request.
  • A valid globalAccountId must be supplied under the merchant block for routing through the global processing rails.

Updated 7 months ago

Did this page help you?
Priority Technology Holdings Logo