Sale Completion

The Adjustment operation allows you to increase the total amount of a previously authorized transaction before it is captured. This is commonly used in scenarios where additional charges are incurred after the original authorization—such as additional tips, taxes, or services.

Prerequisites & Limitations

merchant.processor.name must be "priority".
currencyCode must be "CAD" (Canadian Dollars).
totalAmount must be greater than 0.50.
originalExternalId must reference the original sale transaction to be completed.
Only one sale completion is allowed per original authorization.
If the completion amount is less than the original authorization, the remainder will be released.

Introduction

In this guide, you’ll learn:

How to submit an incremental adjustment using the Vortex API.
How to user validation rules for adjustment amounts.
How to use the response and next steps to finalize the flow.

Adjustment payload

Adjustment

Incremental adjustment payload

{
    "ecom":false,
    "moto":false,
    "recurring":true,
    "externalId":"some-external-id",
    "transactionType":"sale",
    "totalAmount":102.4, // should be higher than the total amount on the authorization
    "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"
        }
    }
}

Incremental adjustment response

{
  reference: 'pi_3RQaWwKX2PidZXm20lcSwGIb',
  status: 'requires_capture',
  approved: true,
  declined: false,
  message: 'Approved',
  requiredActions: 'none',
  totalAmount: 0,
  requestedAmount: 102.4,
  surchargeAmount: 0,
  code: 0,
  availableAmount: 102.4,
  authorization: {
    avsChecks: { addressLine1: false, postalCode: false, cvc: false },
    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: 'hhpTkIlfVsZu+LS38JAFwg==',
  meta: {
    id: 'hhpTkIlfVsZu+LS38JAFwg==',
    externalId: '1747687434594',
    received: '2025-05-19T20:43:54.788Z',
    tenantId: 'A1A9550E-830C-474E-9836-DFD4DB492BC0',
    tenantName: 'Test Tenant',
    replicationGroup: 'qa',
    virtualEnv: 'qa-atl',
    originatingInstance: 'natl',
    environment: 'default'
  }
}

Implementation Notes

You do not need to reference the original authorization explicitly; matching is handled via externalId and account fingerprint.
If the adjustment is too large or exceeds account limits, the response will show declined: true and include a descriptive message.
Always check that the status returned is requires_capture before proceeding to the capture phase.
No funds are transferred to the merchant until a successful capture occurs.