Void
This guide covers how to void an unused authorization in Vortex Global Payments using Priority as the processor.
Void
The Void operation is used to cancel a previously authorized transaction that has not yet been captured. This is a critical step in scenarios where the merchant no longer intends to complete the transaction (e.g., a customer cancels their order).
Void is only supported for unused authorizations—meaning no funds from the authorization have been captured.
Prerequisites & Limitations
- Only authorizations that are fully unused (i.e., with no partial capture) can be voided.
- Must be invoked before the authorization expires (typically within 7 days).
- Only supported with the
priorityprocessor. - Voids cannot be performed after funds have been captured. Use a refund instead.
- The
transactionTypemust be"void".
Introduction
In this guide, you’ll find:
- How to submit a void request for an open authorization.
- How to avoid common pitfalls such as trying to void a captured transaction.
- How to interpret the response to confirm success.
Void
Void an authorization with unused amount is the only supported scenario for voids.
{
"ecom":false,
"moto":false,
"recurring":true,
"externalId":"some-external-id",
"transactionType":"void",
"totalAmount":102.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"
}
}
}Void an authorization with unused amount response
{
reference: 'pi_3RQaeLKX2PidZXm21KSi82ud',
status: 'succeeded',
approved: true,
declined: false,
message: 'Approved',
requiredActions: 'none',
totalAmount: 102.4,
requestedAmount: 102.4,
surchargeAmount: 0,
code: 0,
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: 'cBtAvLAmneu2jfaLkFjhgg==',
meta: {
id: 'cBtAvLAmneu2jfaLkFjhgg==',
externalId: '1747687886294',
received: '2025-05-19T20:51:26.494Z',
tenantId: 'A1A9550E-830C-474E-9836-DFD4DB492BC0',
tenantName: 'Test Tenant',
replicationGroup: 'qa',
virtualEnv: 'qa-atl',
originatingInstance: 'natl',
environment: 'default'
}
}Implementation Notes
- Voids do not transfer any funds back to the cardholder; they simply cancel the original authorization.
- Always check that
approvedistrueandstatusis"succeeded"before assuming the authorization was canceled. - If the authorization has already been partially or fully captured, this request will fail.
- The
externalIdshould match the ID used in the original authorization request to ensure accurate linking.
Updated 7 months ago
Did this page help you?
