--- title: "Void authorization" method: POST path: "/api/v2/transactions/{id}/void" tags: ["Payment Modifications"] --- # Void authorization `POST /api/v2/transactions/{id}/void` Void/Cancel an authorization hold on a payment. Check the documentation in order to verify what payment method allows for this payment modification. ## Path parameters - `id` string, required ## Response `201` Ecommerce Payment Result - EcomResponse - `id` string, uuid-flexible — The ID of the transaction. - `payment_provider_contract` string, uuid-flexible — The identifier of payment provider contract you want to process the transaction request with. - `amount` integer — Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field. - `blocked` boolean — True if the transaction has been blocked by a ruleset, false otherwise - `created_at` string, date-time — The time at which the transaction was created. - `customer` string — The ID of a customer - `invoice_number` string — Optional. The invoice number to track this payment. - `merchant_reference` string — A reference specified by the merchant to identify the transaction - `payment_product` string — The payment product corresponding to this transaction - `payment_product_type` string — The name of the processor used for this transaction - `processor_reference` string — Reference identifying the transaction, as provided by the processor. - `processor_details` object — Stores all details specific for the processor of the transaction. - `status` 'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CANCELLED' | 'CUSTOMER_ACCEPTED' | 'REFUNDED' | 'FAILED' | 'PENDING' | 'DECLINED' | 'SETTLEMENT_CANCELLED' | 'SETTLEMENT_REQUESTED' | 'SETTLEMENT_SUBMITTED' | 'SETTLEMENT_COMPLETED' | 'SETTLEMENT_PARTIAL' | 'SETTLEMENT_DECLINED' | 'VOIDED' | 'UNKNOWN' — The outcome of the payment request. - `status_reason` string — Message provided by the 3rd party service as additional information, when the transaction does not succeed. - `shipping_information` ShippingInformation - `address` string, required — Street address of the recipient. - `city` string, required — City of the recipient. - `country` string, country-code, required — A 2-letter ISO3166 alpha-2 country code for the address. - `postal_code` string, required — A postal code for the address. - `email` string, email — A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1. - `first_name` string — First name of the recipient. - `last_name` string — Last name of the recipient. - `phone` number — Numbers only, no dash or any other separator. - `state` string — A region / state / province for the address. - `arn` string — Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions. - `authorization_code` string — * When the payment is authorized successfully, this field holds the authorization code for the payment. * When the payment is not authorized, this field is not returned. - `avs_result` 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'I' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'R' | 'S' | 'T' | 'U' | 'W' | 'X' | 'Y' | 'Z' — Address verification services result, which provides information about the outcome of the AVS check. The full list of codes and descriptions can be found here - `card` string — The token representing the payment card - `created_by` string — The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order - `cvv_present` boolean — True if the card was used with a cvv - `cvv_result` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '9' | 'M' | 'Y' | 'N' | 'P' | 'S' | 'U' — The CVC verification result, which provides information about the outcome of the CVC check. CVC-CVV result codes: * `0` Unknown * `1` Matches. * `2` Doesn't match. * `3` Not checked. * `4` No CVC/CVV provided, but was required. * `5` Issuer not certified for CVC/CVV. * `6` No CVC/CVV provided. The following are included only for backwards compatibility. They are deprecated and will be removed in the next major release. The client must take action now to ensure ongoing support. * `M` Match * `Y` Match * `N` No Match * `P` Not Processed * `S` CVV Should be present, but Merchant indicates not present. * `U` Issuer not certified or registered to process card verification. - `cavv_result` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '99' | 'A' | 'B' | 'C' | 'D' | 'I' | 'U' | 'NA' — This field will be populated for any Verified by Visa transaction and AVV Authorisation message sent by MasterCard SecureCode: This includes CAVV and AEVV from American Express SafeKey. CAVV Transaction Response Code Values: * `0` CAVV or AEVV Not Validated due to erroneous data submitted. * `1` CAVV or AEVV Failed Validation - Authentication Transaction. This is an indication of potential bad or fraudulent data submitted. * `2` CAVV or AEVV Passed Validation – Authentication Transaction. * `3` CAVV or AEVV Passed Validation – Attempted Authentication Transaction. (Determined that the Issuer ACS generated this value from the use of the Issuer’s CAVV/AEVV key[s]). * `4` CAVV or AEVV Failed Validation – Attempted Authentication Transaction. Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (Determined that Visa generated this value from the use of CAVV/AEVV key[s]). * `5` Reserved. * `6` CAVV or AEVV Not Validated – Issuer not participated. This value is generated when an Issuer requests the `do not verify` flag to be established for its BINs. This parameter enables an Issuer to temporarily stop CAVV/AEVV verification while resolving CAVV/AEVV key issues. VisaNet processes this value as a valid CAVV/AEVV. * `7` CAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (CAVV/AEVV generated with Visa Key). * `8` CAVV or AEVV Passed Validation – Attempted Authentication Transaction. (CAVV/AEVV generated with Visa Key). * `9` CAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV (CAVV/AEVV generated with Visa Key – Issuer ACS unavailable). * `99` An unknown value was returned from the processor. * `A` CAVV or AEVV Passed Validation – Attempted Authentication Transaction. (CAVV/AEVV generated with Visa Key – Issuer ACS unavailable). * `B` CAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (CAVV/AEVV generated with Visa Key). * `C` CAVV or AEVV Not Validated – Attempted Authentication Transaction. Issuer did not return a CAVV/AEVV results code in the authorisation response. VisaNet will treat this as valid CAVV/AEVV if the Issuer approves the authorisation. * `D` CAVV or AEVV Not Validated – Authentication. Issuer did not return a CAVV/AEVV results code in the authorisation response. VisaNet will treat this as valid CAVV/AEVV if the Issuer approves the authorisation. * `I` Invalid Security Data. * `U` Issuer does not participate or 3-D Secure data not utilised. * `NA` Blank CAVV or AEVV Not Present. - `stored_credential` StoredCredential - `reference` string — Reference of a successfully processed initial COF transaction. Only used by subsequent COF transactions. - `stored_credential_type` string - `scheme_reference` string — Scheme Reference Data received from issuer/acquirer. - `processing_model` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'CREDENTIAL_ON_FILE' | 'RECURRING' | 'REAUTHORIZATION' | 'NONE' — Processing model to use for COF transaction. Refer to the card integration guide for more information on the usage. - `details` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'CREDENTIAL_ON_FILE' | 'RECURRING' — Processing model to use for COF transaction. Refer to the card integration guide for more information on the usage. - `details` Details - `auto_capture` boolean - `mid` string, integer — Merchant ID (MID) - `reason_code` string — A reason code assigned by the acquiring platform; '0000' in case of success - `rrn` string — A client (user friendly) identifier for the transaction generated at the outset of a business event. The format will be dependent on the calling system. A reference supplied by the system retaining the original source information and used to assist in locating that transaction or a copy of the transaction. This value is critical in matching values that are sent to other Payment processors or Acquirers. This value would correspond to the **ISO8583 specification as RRN in attribute DE 37, which limits the value to being an alphanumeric value 12 characters.** For the GSC client android application the format will correspond to YYMMdd. - `shopper_interaction` 'ECOMMERCE' | 'MAIL' | 'TELEPHONE' — Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth - `stan` string — System Trace Audit Number. - `reversal_status` 'NONE' | 'REQUIRED' | 'COMPLETED' — Indicates to the API client if a technical reversal has been completed by Verifone. - `geo_location` number[] — The latitude / longitude resolved from the customer's ip address. - `city` string — The city resolved from the customer's ip address. - `country_code` string — The country code resolved from the customer's ip address. - `additional_data` AdditionalData — Additional payment result data, which may be required to return in a particular payment response. - `acquirer_response_code` string — Acquirer response returned during the authorisation. - `acquirer_response_message` string — The response description generated by the acquirer corresponding to the acquirer response code. - `acquirer_authorizing_network_id` string — The Network ID returned in the original authorization response. - `acquirer_authorizing_network_id_descriptor` string — The name or descriptor that corresponds with the `acquirer_authorizing_network_id` returned in the original authorization response. - `initiator_trace_id` string — A number assigned by a transaction initiator(originator) to assist in identifying a transaction uniquely. The trace identifier remains unchanged for all messages within a two-message exchange, e.g. request/repeat and response. This property can be used to store the System trace audit number (STAN) as used in the ISO8583 specification (DE 11). Note the contents of this field are mandatory in many specifications - ISO8583, AS2805 (DE11) and are often related to the Retrieval Reference Number (RRN) as also specified in ISO8583. Unfortunately due to the usage in these earlier specifications, a STAN was limited to 6 digits which means that it cannot be utilised as a general purpose unique id. In addition, this entry is often printed on the receipt at a POI. This value will correspond to **ISO8583 DE11.** `Note: Use response.stan value for initiator_trace_id` - `settlement_date` string, date — This will reflect either the desired Merchant settlement date or the actual settlement date depending where the transaction request is within the payment lifecycle. A transaction may be assigned an intended settlement date, but it is possible that this date will not occur for technical reasons hence there should be a subsequent event to indicate the actual date of settlement. Format is date only as per RFC 3339. - `issuer_receipt_text` string — Additional text to print on transaction receipt, which optionally may be provided by the Issuer. - `token_details` TokenDetails - `reuse_token` string — The Verifone issued reuse token used to represent the previously stored cardholder data. - `reuse_token_type` 'CHASE' | 'INTERNAL' | 'TAVE' — The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type. - `analytics_token` string — A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes. - `token_expiry_date` string, date — When this Token will expire. - `token_scope` string, uuid — The token scope under which this token was created. - `token_status` 'DELETED' | 'ACTIVE' | 'SUSPENDED' — The status of the Token. - `created_at` string, date — The date when this token was first created. - `updated_at` string, date — The last date token was updated. - `variant` string — The variant of the card. eg. NEW_WORLD - `type` 'CREDIT' | 'DEBIT' — The type of card application or account selection. - `issuer_name` string — The issuer of this card. eg. HSBC, BARCLAYS. - `issuer_country` 'ZZZ' | 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BSB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MOZ' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGC' | 'SGP' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE' — The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code.
Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
. - `brand` string — The brand of this card. eg. VISA, MASTERCARD, AMEX. - `expiry_year` integer — A 4 digit value as shown on card. - `expiry_month` integer — A 2 digit value as shown on card. ISO8583 - DE 14 - `card_holder_name` string — The Card holder name as it appears on the card. - `last_four` string — The last 4 digits of the card number. - `bin` string — The Bank Identification Number (also called IIN - Issuer Identification Number) of this card. - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' — Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). - `promo_code` string — A code defined by the merchant that affects the calculation of the total amount. - `purchase_order_number` string — The purchase order number. It can be provided in transactions with purchase or procurement cards for the cardholder to get better interchange rates (note that this functionality needs alignment with the acquirer and the scheme). This field is part of so-called Level 2 data. - `issuer_instalment_result` EcomPaymentResponseIssuerInstalmentResult — Issuer-managed instalment response. May be used to inform on supported instalment options for the transaction in specific programs (e.g., Mastercard Instalment Payment Service). - `instalment_program` 'MCINST' — The name of special program designated by scheme or issuer. - `payment_option` 'FULL' | 'FULL_OR_INSTALMENT' | 'INSTALMENT' — Available payment mode allowed by issuer for the transaction. - `payment_plan_option` PaymentPlanOption[] — The issuer may offer more than one instalment options within certain instalment programs. - `number_of_instalments` integer — The number of individual parts that the total amount should be paid in. - `first_instalment_amount` number — Amount including decimal place. - `instalment_amount` number — Amount including decimal place. - `interest_rate` number, float — The interest rate. - `annual_percentage_rate` number, float — The interest rate expressed in Annual Percentage Rate. - `handling_fee` number — Amount including decimal place. - `total_amount_with_cost` number — Amount including decimal place. - `number_of_instalments` integer — The number of individual parts that the total amount should be paid in. - `min_number_of_instalments` integer — The minimal number of individual parts that the total amount could be paid in, if choice is available. - `max_number_of_instalments` integer — The maximal number of individual parts that the total amount could be paid in, if choice is available. - `interest_rate` number, float — The interest rate. - `annual_percentage_rate` number, float — The interest rate expressed in Annual Percentage Rate. - `handling_fee` number — Amount including decimal place. - `down_payment_amount` number — Amount including decimal place. - `instalment_amount` number — Amount including decimal place. - `total_amount_with_cost` number — Amount including decimal place. - `promo_financing_result` PromoFinancingResults — Details of the special financing offer returned from the issuer. - `promoFinancingType` 'PROMO_APR' | 'PROMO_AND_AFTER_APR' | 'NO_PROMO' | 'ERROR' — Type of special financing information provided. * `PROMO_APR ` - APR information provided only for the duration of the promo period; * `PROMO_AND_AFTER_APR ` - APR information provided for the duration of and after the promo period; * `PROMO_AND_AFTER_APR ` - No promotional financing available; * `ERROR ` - error. - `promoAnnualPercentageRateType` 'FIXED' | 'VARIABLE' — The type of APR applicable during promo period. - `promoAnnualPercentageRate` number, float — The interest rate expressed in Annual Percentage Rate (APR), applicable during the promo period. - `annualPercentageRateType` 'FIXED' | 'VARIABLE' — The type of APR applicable after promo period. - `annualPercentageRate` number, float — The interest rate expressed in Annual Percentage Rate (APR). - `promoDurationDescription` string — Information or description of the promo period duration, e.g. 6 months - `promoDescription` string — Description of the promotional financing plan. - `balance_amount` integer — Balance amount is the amount remaining on a card or account of cardholder without a decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217: ## Other responses - `400` — Bad Request - `401` — Unauthorised - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)