Payment Modifications

Payment modification endpoints act on a transaction that was previously created via Ecom Payments or Alternative Payment Methods. All path-based endpoints require the original {id} from the initiation response.

Not all modification types are supported by every payment method. Refer to the Verifone payment actions documentation to confirm support before calling these endpoints.

Capture Authorization

Captures an authorization hold. Use capture_now: false on initiation to defer capture.

Capture authorization

post

/api/v2/transactions/{id}/capture

Capture an authorization hold on a payment. Check the documentation in order to verify what payment method allows for this payment modification.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to capture.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Body

amountintegerRequired

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.

Example: 150

purchase_order_numberstring · max: 17Optional

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.

tax_indicatorstring · enumOptional

This field indicates the taxable status of the transaction (if any of the purchased items are taxable). This field is part of so-called Level 2 data. If the value TAX_PROVIDED is sent, tax_amount should also be provided

Default: TAX_NOT_PROVIDEDPossible values:

receipt_typestring · enumOptional

Defines the type of receipt to be generated

Possible values:

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/capture

POST /oidc/api/v2/transactions/{id}/capture HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 764

{
  "amount": 150,
  "purchase_order_number": "text",
  "tax_indicator": "TAX_NOT_PROVIDED",
  "multiple_captures": {
    "final_capture": true,
    "capture_sequence_number": 1,
    "capture_sequence_count": 1
  },
  "issuer_instalment": {
    "instalment_program": "MCINST",
    "number_of_instalments": 1,
    "down_payment_amount": 1,
    "first_instalment_amount": 1,
    "instalment_amount": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "total_amount_with_cost": 1
  },
  "line_items": [
    {
      "name": "text",
      "quantity": 1,
      "unit_price": 1,
      "unit_price_tax": 1,
      "tax_rate": "15.10",
      "total_tax_amount": 1,
      "total_amount": 1,
      "image_url": "text",
      "item_url": "text",
      "sku": "text",
      "description": "text",
      "category": "DIGITAL_GOODS"
    }
  ],
  "detailed_amount": {
    "gratuity_amount": 150,
    "tax_amount": 150,
    "surcharge_amount": 150
  },
  "receipt_type": "FULL_RECEIPT"
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Multiple partial captures are supported via multiple_captures.capture_sequence_number and capture_sequence_count. Set final_capture: false until the last partial capture.

Void Authorization

Cancels an authorization hold before capture.

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.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to cancel / void.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/void

POST /oidc/api/v2/transactions/{id}/void HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Void Capture

Cancels a transaction after it has already been captured. Only the full transaction amount can be voided.

Void capture

post

/api/v2/transactions/{id}/void_capture

Cancel a payment that has previously been captured. Void capture can only be done on the full amount of the transaction. Check the documentation to verify what payment method allows for this payment modification.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to cancel / void the capture.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/void_capture

POST /oidc/api/v2/transactions/{id}/void_capture HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Refund Payment

Refunds a previously captured transaction, fully or partially.

Refund payment

post

/api/v2/transactions/{id}/refund

Refund a payment that has previously been captured.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to refund.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Header parameters

x-vfi-api-idempotencykeystring · uuidOptional

Note: This value is required to process a refund for an Affirm payment.

Example: 63bbc548-d2de-4546-b106-880a5018461c

Body

amountintegerRequired

Example: 150

reasonstringOptional

The reason of the refund.

tax_indicatorstring · enumOptional

Default: TAX_NOT_PROVIDEDPossible values:

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

receipt_typestring · enumOptional

Defines the type of receipt to be generated

Possible values:

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/refund

POST /oidc/api/v2/transactions/{id}/refund HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "amount": 150,
  "reason": "text",
  "tax_indicator": "TAX_NOT_PROVIDED",
  "detailed_amount": {
    "gratuity_amount": 150,
    "tax_amount": 150,
    "surcharge_amount": 150
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "receipt_type": "FULL_RECEIPT"
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Unmatched Refund

Refunds a cardholder without reference to a prior transaction. Accepts either an encrypted card or a reuse token.

Unmatched refund

post

/api/v2/transactions/refund

Refund a cardholder with an amount not related to a previous transaction.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/refund

POST /oidc/api/v2/transactions/refund HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 979

{
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "card_brand": "text",
  "brand_choice": "MERCHANT",
  "amount": 1,
  "detailed_amount": {
    "gratuity_amount": 150,
    "tax_amount": 150,
    "surcharge_amount": 150
  },
  "currency_code": "AED",
  "customer": "0a57b387-2ba7-4f65-be2f-e176bb49d2ce",
  "shopper_interaction": "ECOMMERCE",
  "reason": "text",
  "merchant_reference": "7a1db7a8-6f24-4bc5-a51b-cef33fc05140",
  "line_items": [
    {
      "name": "text",
      "quantity": 1,
      "unit_price": 1,
      "unit_price_tax": 1,
      "tax_rate": "15.10",
      "total_tax_amount": 1,
      "total_amount": 1,
      "image_url": "text",
      "item_url": "text",
      "sku": "text",
      "description": "text",
      "category": "DIGITAL_GOODS"
    }
  ],
  "receipt_type": "FULL_RECEIPT",
  "tax_indicator": "TAX_NOT_PROVIDED",
  "purchase_order_number": "text",
  "promo_code": "text",
  "promo_financing_details": {
    "promoFinancingType": "PROMO_APR",
    "promoPlan": "text",
    "promoPlanExpiry": "2026-01-01"
  },
  "encrypted_card": "U3dhZ2dlciByb2Nrcw==",
  "encrypted_svc_access_code": "text",
  "public_key_alias": "text",
  "prefer_fund_transfer": false
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Adjust Pre-Authorization Amount

Modifies the amount of a pending pre-authorization before capture. An amount greater than the original increments; an amount less decrements. Set to 0 to fully void after an increment.

Adjust the preauth transaction amount

post

/api/v2/transactions/{id}/adjust

Allows for the modification of the amount of a previously initiated preauthorization before it is captured.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to adjust.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Body

amountintegerRequired

Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, refer to the Currencies documentation for more details. The amount provided determines the type of adjustment. If it is greater than the original pre-authorization amount, it is treated as an increment. If it is less than the original pre-authorization amount, it is treated as a decrement. To fully void a transaction after an increment, set the amount to 0.

Example: 150

reasonstringOptional

The reason of the adjust.

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/adjust

POST /oidc/api/v2/transactions/{id}/adjust HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "amount": 150,
  "reason": "text"
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Release Pre-Authorization

Releases the remaining uncaptured funds on a pre-authorization. This is a one-time, irreversible operation — no further captures are allowed after calling this endpoint.

Release PreAuthorization

post

/api/v2/transactions/{id}/release

Release the rest of preauthorisation which was not captured. This is a one time operation where all remaining funds are released. No further captures are allowed after that. Rest of amount to be released is automatically calculated internally.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original preauthorized transaction id to release

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Header parameters

x-vfi-api-idempotencykeystringOptional

string(uuid)

Example: 63bbc548-d2de-4546-b106-880a5018461c A value you specify that uniquely identifies this transaction. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the transaction.

Body

amountintegerOptional

Amount is charged without a decimal place e.g. $1.5 = 150. The required number of decimal places for a currency code is according to ISO For Account Verification transaction, provide 0 as value for this field.

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/release

POST /oidc/api/v2/transactions/{id}/release HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "amount": 1
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Extend Pre-Authorization

Extends the authorisation period of a pending pre-authorization and re-confirms fund availability. For Visa, this is processed as a Reauthorization request.

Extend preauthorization

post

/api/v2/transactions/{id}/extend

Extend the authorization period and confirm the availability of the funds of a previously initiated preauthorization. If supported by the card brand (like Visa) this operation will be handled as a Reauthorization request.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original preauthorized transaction id to release

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Header parameters

x-vfi-api-idempotencykeystringOptional

string(uuid)

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/extend

POST /oidc/api/v2/transactions/{id}/extend HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

Technical Reversal

Triggers a technical reversal using the original idempotency key. Use this when a transaction request timed out and you are uncertain whether it was processed.

x-vfi-api-idempotencykey is required and must match the key used in the original payment request.

Reverse Transaction

post

/api/v2/transactions/reverse

Allows for technical reversal

Authorizations

AuthorizationstringRequired

Header parameters

x-vfi-api-idempotencykeystringRequired

string(uuid)

Responses

201

Technical Reversal Result

application/json

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/reverse

POST /oidc/api/v2/transactions/reverse HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
x-vfi-api-idempotencykey: text
Accept: */*

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "status": "REFUNDED"
}

Issuer Instalment Selection

Confirms the shopper's selected instalment option when the issuer returns multiple options (for example, via Mastercard Instalment Payment Service).

Issuer Instalment Selection

post

/api/v2/transactions/{id}/issuer_instalment_selection

Confirm selection of instalment option where multiple issuer instalment options proposed.

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Original transaction id to apply instalment selection to.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Body

Responses

201

Ecommerce Payment Result

application/json

idstring · uuid-flexibleOptional

The ID of the transaction.

Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

payment_provider_contractstring · uuid-flexibleOptional

The identifier of payment provider contract you want to process the transaction request with.

Example: 30b8bec8-5042-4e67-939c-5453fbe41711

amountintegerOptional

Example: 0

blockedbooleanOptional

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring · date-timeOptional

The time at which the transaction was created.

customerstringOptional

The ID of a customer

invoice_numberstring · max: 127Optional

Optional. The invoice number to track this payment.

merchant_referencestringOptional

A reference specified by the merchant to identify the transaction

payment_productstringOptional

The payment product corresponding to this transaction

payment_product_typestringOptional

The name of the processor used for this transaction

processor_referencestringOptional

Reference identifying the transaction, as provided by the processor.

processor_detailsobjectOptional

Stores all details specific for the processor of the transaction.

statusstring · enumOptional

The outcome of the payment request.

Example: AUTHORIZEDPossible values:

status_reasonstringOptional

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

arnstringOptional

Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.

authorization_codestring · max: 6Optional

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.

Example: 5B1D4C

avs_resultstring · enumOptional

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

Example: APossible values:

cardstringOptional

The token representing the payment card

created_bystringOptional

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

cvv_presentbooleanOptional

True if the card was used with a cvv

cvv_resultstring · enumOptional

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.

Example: 1Possible values:

cavv_resultstring · enumOptional

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.

Example: 99Possible values:

reason_codestring · max: 4Optional

A reason code assigned by the acquiring platform; '0000' in case of success

rrnstring · max: 12Optional

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.

For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.

Example: 200211654321

shopper_interactionstring · enumOptional

Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth

Possible values:

stanstringOptional

System Trace Audit Number.

reversal_statusstring · enumOptional

Indicates to the API client if a technical reversal has been completed by Verifone.

Default: NONEPossible values:

geo_locationnumber[]Optional

The latitude / longitude resolved from the customer's ip address.

Example: ["52.370216","4.895168"]

citystringOptional

The city resolved from the customer's ip address.

Example: West Roxbury

country_codestringOptional

The country code resolved from the customer's ip address.

Example: US

promo_codestringOptional

A code defined by the merchant that affects the calculation of the total amount.

purchase_order_numberstring · max: 17Optional

balance_amountintegerOptional

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:

400

Bad Request

application/json

401

Unauthorised

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v2/transactions/{id}/issuer_instalment_selection

POST /oidc/api/v2/transactions/{id}/issuer_instalment_selection HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "issuer_instalment": {
    "instalment_program": "MCINST",
    "number_of_instalments": 1,
    "down_payment_amount": 1,
    "first_instalment_amount": 1,
    "instalment_amount": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "total_amount_with_cost": 1
  }
}

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "payment_provider_contract": "30b8bec8-5042-4e67-939c-5453fbe41711",
  "amount": 0,
  "blocked": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "customer": "text",
  "invoice_number": "text",
  "merchant_reference": "text",
  "payment_product": "text",
  "payment_product_type": "text",
  "processor_reference": "text",
  "processor_details": {},
  "status": "AUTHORIZED",
  "status_reason": "text",
  "shipping_information": {
    "address": "3732  Metz Lane",
    "city": "West Roxbury",
    "country": "US",
    "postal_code": "1114",
    "email": "name@gmail.com",
    "first_name": "Thelma",
    "last_name": "Tatro",
    "phone": 8577532706,
    "state": "MA"
  },
  "arn": "text",
  "authorization_code": "5B1D4C",
  "avs_result": "A",
  "card": "text",
  "created_by": "text",
  "cvv_present": true,
  "cvv_result": "1",
  "cavv_result": "99",
  "stored_credential": {
    "reference": "text",
    "stored_credential_type": "text",
    "scheme_reference": "text",
    "processing_model": "UNSCHEDULED_CREDENTIAL_ON_FILE"
  },
  "details": {
    "auto_capture": true,
    "mid": "363162200000049"
  },
  "reason_code": "text",
  "rrn": "200211654321",
  "shopper_interaction": "ECOMMERCE",
  "stan": "text",
  "reversal_status": "NONE",
  "geo_location": [
    "52.370216",
    "4.895168"
  ],
  "city": "West Roxbury",
  "country_code": "US",
  "additional_data": {
    "acquirer_response_code": "0000",
    "acquirer_response_message": "text",
    "acquirer_authorizing_network_id": "text",
    "acquirer_authorizing_network_id_descriptor": "text",
    "settlement_date": "2026-01-01",
    "issuer_receipt_text": "text"
  },
  "token_details": {
    "reuse_token": "text",
    "reuse_token_type": "CHASE",
    "analytics_token": "text",
    "token_expiry_date": "2026-01-01",
    "token_scope": "123e4567-e89b-12d3-a456-426614174000",
    "token_status": "DELETED",
    "created_at": "2026-01-01",
    "updated_at": "2026-01-01",
    "variant": "NEW_WORLD",
    "type": "CREDIT",
    "issuer_name": "HSBC",
    "issuer_country": "ZZZ",
    "brand": "VISA",
    "expiry_year": 2021,
    "expiry_month": 12,
    "card_holder_name": "MR J HOLDER",
    "last_four": "3127",
    "bin": "492912",
    "currency_code": "AED"
  },
  "promo_code": "text",
  "purchase_order_number": "text",
  "issuer_instalment_result": {
    "instalment_program": "MCINST",
    "payment_option": "FULL",
    "payment_plan_option": [
      {
        "number_of_instalments": 1,
        "first_instalment_amount": 1,
        "instalment_amount": 1,
        "interest_rate": 1,
        "annual_percentage_rate": 1,
        "handling_fee": 1,
        "total_amount_with_cost": 1
      }
    ],
    "number_of_instalments": 1,
    "min_number_of_instalments": 1,
    "max_number_of_instalments": 1,
    "interest_rate": 1,
    "annual_percentage_rate": 1,
    "handling_fee": 1,
    "down_payment_amount": 1,
    "instalment_amount": 1,
    "total_amount_with_cost": 1
  },
  "promo_financing_result": {
    "promoFinancingType": "PROMO_APR",
    "promoAnnualPercentageRateType": "FIXED",
    "promoAnnualPercentageRate": 1,
    "annualPercentageRateType": "FIXED",
    "annualPercentageRate": 1,
    "promoDurationDescription": "text",
    "promoDescription": "text"
  },
  "balance_amount": 1
}

PreviousAlternative Payment Methods

NextTransactions

Last updated 3 months ago

Was this helpful?