Transaction Types

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Sale And Tokenize Card

SaleAndTokenizeCard Method

A sale operation which also returns a card token. This functionality is not available for all acquirers, please check with Handpoint to know if tokenization is supported for your acquirer of choice.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the transaction.
`map` Map	A map including optional transaction parameters.

Code example

//Initiate a sale for 10.00 in Great British Pounds
api.SaleAndTokenizeCard(new BigInteger("1000"),Currency.GBP);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Sale Reversal

SaleReversal Method

A sale reversal, also called sale VOID allows the user to reverse a previous sale operation. This operation reverts (if possible) a specific sale identified with a transaction id. In its simplest form you only have to pass the amount, currency and originalTransactionID but it also accepts a map with optional parameters. Note that transactions can only be reversed within a 24 hours timeframe or until the daily batch of transactions has been sent for submission.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the transaction.
`originalTransactionID` Required String	Id of the original sale transaction (EFTTransactionID)
`map` Map	A map including optional transaction parameters.

Code example

//Initiate a reversal for 10.00 Pounds
api.SaleReversal(new BigInteger(1000),Currency.GBP,"00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Refund

Refund Method

A refund operation moves funds from the merchant account to the cardholder´s credit card. In it's simplest form you only have to pass the amount and currency but it also accepts a map with optional parameters. Note that a card is required to be swiped, dipped or tapped for this operation. For Interac (Canadian Debit Network), refunds can only be processed until Interac closes the batch of transactions at night.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the transaction.
`originalTransactionID` String	Id of the original sale transaction (EFTTransactionID)
`map` Map	A map including optional transaction parameters.

Code example

//Initiate a refund for 10.00 in Great British Pounds
api.Refund(new BigInteger(1000),Currency.GBP,"00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Refund Reversal

RefundReversal Method

A Refund Reversal, also called Refund VOID allows the merchant to reverse a previous refund operation. This operation reverts (if possible) a specific refund identified with a transaction id. In its simplest form you only have to pass the amount, currency and originalTransactionID but it also accepts a map with optional parameters. Note that transactions can only be reversed within the same day as the transaction was made.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the transaction.
`originalTransactionID` Required String	Id of the original refund transaction (EFTTransactionID)
`map` Map	A map including optional transaction parameters.

Code example

//Initiate a refund reversal for 10.00 in Great British Pounds
api.RefundReversal(new BigInteger(1000),Currency.GBP,"00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

MoTo Sale

moToSale Method

Mail Order /Telephone Order (MOTO) sale. MOTO is a type of card-not-present (CNP) transaction in which services are paid and delivered via telephone, mail, fax, or internet communication. MOTO has become synonymous with any financial transaction where the entity taking payment does not physically see the card used to make the purchase.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the transaction.
`map` Map	A map including optional transaction parameters.

Code example

// Basic
this.Hapi.MotoSale(new BigInteger("1000"), Currency.EUR);

// With options
Dictionary dic = new Dictionary();
dic.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");

this.Hapi.MotoSale(new BigInteger("1000"), Currency.EUR, dic);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

MoTo Refund

moToRefund Method

A MOTO refund operation moves funds from the merchant account to the cardholder´s credit card. In it's simplest form you only have to pass the amount and currency but it also accepts the original transaction id. MOTO Refund is a type of card-not-present (CNP) transaction in which services are refunded via telephone, mail, fax, or internet communication. MOTO has become synonymous with any financial transaction where the entity taking payment does not physically see the card used to make the purchase or refund.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` RequiredCurrency	Currency of the transaction.
`originalTransactionId` String	If present it links the refund with a previous sale. It effectively limits the maximum amount refunded to that of the original transaction.
`map` Map	A map including optional transaction parameters.

Code example

this.Hapi.MotoRefund(new BigInteger(1000), Currency.EUR);

this.Hapi.MotoRefund(new BigInteger(1000), Currency.EUR, "00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

MoTo Reversal

moToReversal Method

A MOTO reversal, also called VOID allows the user to reverse a previous sale/refund operation. This operation reverts (if possible) a specific operation identified with a transaction id. Note that transactions can only be reversed within a 24 hours timeframe or until the daily batch of transactions has been sent for submission. MOTO Reversal is a type of card-not-present (CNP) transaction used to reverse a previous MOTO Sale or MOTO Refund.

Parameters

Parameter	Notes
`originalTransactionId` Required String	Id of the original sale transaction.
`map` Map	A map including optional transaction parameters

Code example

this.Hapi.MotoReversal("00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

MoTo Pre-Auth

moToPreAuthorization Method

A MOTO pre-auth initiates a pre-authorization operation to the card reader. It's used to verify that the account is valid and has sufficient funds to cover a pending transaction, without actually debiting the cardholder's account upfront.

Parameters

Parameter	Notes
`amount` Required BigInteger	Transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP).
`currency` Required Currency	Currency of the charge
`map` Map	A map including optional transaction parameters

Code example

this.Hapi.moToPreAuthorization(new BigInteger(1000), Currency.EUR);

// With options
Dictionary map = new Dictionary();
map.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");
map.Add(XmlTag.Metadata1.Tag(), "Data 1");

this.Hapi.moToPreAuthorization(new BigInteger(1000), Currency.EUR, map);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Print Receipt

PrintReceipt Method

Print on demand functionality allowing the merchant to print any HTML formatted receipt. It is possible to print images or barcodes as well as passing directly a URL to the printReceipt function. A bitmap can also be printed, in order to do so it needs to be rendered as an image and inserted into the html.

tip

The receipts are usually received as URLs in the transaction result from the terminal but note that if the terminal is not able to upload the receipt to the Handpoint cloud servers and generate a URL then the HTML formatted receipt will be delivered to your software. It is important to be able to manage both formats.

Parameters

Parameter	Notes
`receipt` Required String	HTML receipt or url to locate the receipt, it can be found in the response of a financial operation, in the fields merchantReceipt or customerReceipt. The receipt must match the following HTML Print Format

Code example

// string validReceipt = '...';
bool success = api.PrintReceipt(validReceipt);

Returns

Parameter	Notes
`Boolean`	`true` if the receipt was sent to the printer, false otherwise

Signature Result

SignatureResult Method

A signatureRequired event is invoked during a transaction when a signature verification is required, for example when a payment is done with a swiped or chip and signature card. The merchant is required to ask the cardholder for signature and approve (or decline) the transaction. signatureResult tells the payment terminal if the signature was approved by passing the value true in the method. To decline a signature event then false should be passed to the payment terminal. Note that this event is only required for an HiLite integration and can be safely ignored for a PAX or Telpo integration.

Parameters

Parameter	Notes
`accepted` Required Boolean	pass true if merchant accepts customer signature

Code example

//Receiving a SignatureRequest from the SDK.
public void SignatureRequired(SignatureRequest signatureRequest, Device device)
{
    //If you accept the signature
    api.SignatureResult(true);
}

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
`Boolean`	`true` if the operation was successfully sent to the payment terminal

Tip Adjustment

TipAdjustment Method

A tip adjustment operation allows merchants to adjust the tip amount of a sale transaction before the batch of transactions is settled by the processor at the end of the day. Note: This functionality is only available for the restaurant industry in the United States and the processors currently supporting this functionality are TSYS and VANTIV. This functionality is limited to HiLite terminals.

Parameters

Parameter	Notes
`originalTransactionID` Required String	Id of the original sale transaction (EFTTransactionID)

Code example

//Initiate a tip adjustment for $10.00
Task<FinancialStatus> result = hapi.TipAdjustment(BigInteger.Parse("1000"), "2bc23910-c3b3-11e6-9e62-07b2a5f091ec");
FinancialStatus status = result.Result;
if (status != FinancialStatus.FAILED)
{
    if (status == FinancialStatus.AUTHORISED)
    {
        //Success!
    }
    else
    {
        //Declined
    }
}

Returns

Result of the tip adjustment transaction, this is an asynchronous method that returns a task called <FinancialStatus>, the possible values are :

Parameter	Notes
FinancialStatus	- FinancialStatus.AUTHORISED (tip adjustment approved by the processor) - FinancialStatus.FAILED (system error or timeout) - FinancialStatus.DECLINED (tip adjustment declined by the processor)

If two tip adjustments are sent for the same sale transaction, the second tip adjustment will override the first one. In case the transaction fails (not declined) we recommend that you prompt the user of the POS to retry the adjustment.

Tokenize Card

TokenizeCard Method

Returns a card token (representing the card number). This functionality is not available for all acquirers, please check with Handpoint to know if tokenization is supported for your acquirer of choice.

Parameters

Parameter	Notes
`map` Map	A map including optional transaction parameters.

Code example

//Initiates a card tokenization operation.
api.TokenizeCard();

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
OperationStartResult	Object containing information about the financial operation started. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter

Notes

Stop Current Transaction

StopCurrentTransaction Method

This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called cancelAllowed in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled.

Code example

this.Hapi.StopCurrentTransaction();

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter	Notes
`Boolean`	`true` if the operation was successfully sent to the payment terminal

Pre-Auth

preAuthorization

A pre-auth initiates a pre-authorization operation to the card reader. In it's simplest form you only have to pass the amount and currency but it also accepts tip configuration and a map with extra parameters. A pre-authorization charge, also known as a pre-auth or authorization hold, is a temporary hold placed on a customer's payment card. It's used to verify that the account is valid and has sufficient funds to cover a pending transaction, without actually debiting the cardholder's account upfront.

Parameters

Parameter	Notes
`amount` Required BigInteger	Amount of funds to be pre-authorized - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
`currency` Required Currency	Currency of the charge
`map` Map	A map including optional transaction parameters.

Code example

// Basic
this.Hapi.PreAuthorization(new BigInteger("1000"), Currency.EUR);

// With options
Dictionary map = new Dictionary();
map.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");
map.Add(XmlTag.Metadata1.Tag(), "Data 1");

this.Hapi.PreAuthorization(new BigInteger("1000"), Currency.EUR, map);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter Notes

OperationStartResult Object containing information about the financial operation performed. Most specifically the transactionReference which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The transactionReference will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Parameter	Notes
OperationStartResult	Object containing information about the financial operation performed. Most specifically the `transactionReference` which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Pre-Auth Increase/Decrease

preAuthorizationIncrease

This operation allows the merchant to increase/decrease the amount of a previously performed pre-auth operation. For example, if a tab was opened at a restaurant and the consumer is adding new orders going above the initial pre-authorized amount, it is required to increase the amount of the initial pre-authorization before capturing it. If the merchant wants to release part of a pre-auth, an increase with negative amount should be passed to the function.

Parameters

Parameter	Notes
`amount` Required BigInteger	Amount of funds to be pre-authorized - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
`currency` Required Currency	Currency of the charge
`originalTransactionID` Required String	Transaction id of the original pre-auth transaction
`map` Map	A map including optional transaction parameters.

Code example

// Basic PreAuth Increase
this.Hapi.PreAuthorizationIncrease(new BigInteger("1000"), Currency.EUR, ""00000000-0000-0000-0000-000000000000");

// With options
Dictionary map = new Dictionary();
map.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");
map.Add(XmlTag.Metadata1.Tag(), "Data 1");

this.Hapi.PreAuthorizationIncrease(new BigInteger("1000"), Currency.EUR, "00000000-0000-0000-0000-000000000000", map);

// Basic PreAuth Decrease
this.Hapi.PreAuthorizationIncrease(new BigInteger("-1000"), Currency.EUR, ""00000000-0000-0000-0000-000000000000");

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter Notes

Parameter	Notes
OperationStartResult	Object containing information about the financial operation performed. Most specifically the `transactionReference` which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Pre-Auth Capture

preAuthorizationCapture

A pre-authorized transaction can be captured to actually debit the cardholder's account. Depending on the merchant category code, the capture needs to happen between 7 and 31 days after the original pre-authorization. If not captured the funds will be automatically released by the issuing bank.

Please note that a pre-authorization can only be captured ONCE, multiple partial captures are not allowed. If for some reason, the pre-authorization was captured for an incorrect amount, you can attempt to reverse the capture (does not work with all acquirers). If the capture reversal was declined, the cardholder needs to come back into the store with his card to get refunded or re-authorize the transaction. Alternatively, the cardholder can give his card details over the phone to the merchant and a MOTO pre-auth or MOTO refund can be issued.

Card schemes set specific rules around which businesses are able to use pre-auth transactions. Eligibility is determined based on the Merchant Category Code (MCC), together with the card scheme.

Card schemes have their own set of rules on authorisation expiry. Capturing a transaction after the scheme expiry time increases the risk of a failed capture, and may also increase the interchange and/or scheme fees charged for the transaction. Card schemes can also expire an authorisation before or after the official scheme expiry period has been reached. You can often capture a payment successfully after an authorisation has expired. Depending on the card scheme, there can be a fee for late capture, and an increase in interchange fee. The risk of cardholder chargebacks increase as well.

Scheme	MCC
Mastercard	All MCCs except 5542
Visa	All MCCs except 5542
Discover	3351-3441, 3501-3999, 4111, 4112, 4121, 4131, 4411, 4457, 5499, 5812, 5813, 7011, 7033, 7996, 7394, 7512, 7513, 7519, 7999
American Express	All MCCs except 5542

VISA rules

MCC	Segment	Authorization timeframe	Amount tolerance (captured amount above pre-authorized amount)
3501-3999, 7011	Lodging	31 days	15%
3351-3500, 7512	Car Rental	31 days	15%
4411	Steamship and Cruise Lines	31 days	15%
7513	Truck Rentals	7 days	15%
7033	Trailer Parks and Campgrounds	7 days	15%
7519	Motor Home and Recreational Vehicle Rentals	7 days	15%
5552	Electric Vehicle Charging	7 days	15%
7523	Parking and Garages	7 days	15%
7394	Equipment, Tool, Furniture and Appliance Rental	7 days	none
7999	Recreation Services	7 days	none
7996	Amusement Parks, Carnivals, Circuses, Fortune Tellers	7 days	none
5599	Miscellaneous Automotive, Aircraft, and Farm Equipment Dealers	7 days	none
4457	Boat Rentals and Leasing	7 days	none
5571	Motorcycle Shops and Dealers	7 days	none
4111	Local and Suburban Commuter, Passenger Transportation, including Ferries	7 days	25 USD (or equivalent amount in local currency)
4112	Passenger Railways	7 days	25 USD (or equivalent amount in local currency)
4131	Bus Lines	7 days	25 USD (or equivalent amount in local currency)
5812	Eating Places and Restaurants	Same day	20%
5813	Drinking Places, Bars, Taverns, Cocktail Lounges, Nightclubs, Discotheques	Same day	20%
4121	Taxicabs and Limousines (Card-Absent Environment only)	Same day	20%

MASTERCARD rules

MCC	Authorization timeframe	Amount tolerance (captured amount above pre-authorized amount)
All MCCs	30 days	20%

Maestro rules

MCC	Segment	Authorization timeframe	Amount tolerance (captured amount above pre-authorized amount)
5812	Eating Places and Restaurants	7 days	20%
5814	Fast Food Restaurants	7 days	20%

AMEX rules

MCC	Authorization timeframe
All MCCs	7 days

Note: Pre-Auth with AMEX is only available in the United States/Canada with the processor TSYS.

Discover rules

MCC	Authorization timeframe
Car Rental, Hotel/Lodging MCCs	30 days
All MCCs except Car Rental and Hotel/Lodging	10 days

Diners rules

MCC	Debit/credit	Authorization timeframe
Car Rental, Hotel/Lodging MCCs	All	30 days
All MCCs except Car Rental and Hotel/Lodging	Credit	30 days
All MCCs except Car Rental and Hotel/Lodging	Debit	7 days

JCB rules

MCC	Authorization timeframe
Hotel and Car rental	Time of stay/rental
All MCCs except Hotel and Car rental	1 year

Parameters

Parameter	Notes
`amount` Required BigInteger	Amount of funds to be pre-authorized - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
`currency` Required Currency	Currency of the charge
`originalTransactionID` Required String	Transaction id of the original pre-auth transaction

Code example

// Basic
this.Hapi.PreAuthorizationCapture(new BigInteger("1000"), Currency.EUR, "00000000-0000-0000-0000-000000000000");

// With options
Dictionary map = new Dictionary();
map.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");
map.Add(XmlTag.Metadata1.Tag(), "Data 1");

this.Hapi.PreAuthorizationCapture(new BigInteger("1000"), Currency.EUR, "00000000-0000-0000-0000-000000000000", map);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.

This event is invoked when the transaction is completed, it contains the transaction result and receipts.

Returns

Parameter Notes

Parameter	Notes
OperationStartResult	Object containing information about the financial operation performed. Most specifically the `transactionReference` which must be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.

Pre-Auth/Capture Reversal

preAuthorizationReversal

A Pre-Auth reversal allows the user to reverse a previous pre-auth operation. This operation reverts (if possible) a specific pre-auth identified with a transaction id. A pre-authorized reversal transaction will released the whole pre-authorized amount, for example when renting a car, the pre-auth reversal allows the merchant to release the funds if the car was not damaged. For partial releases, please check the Pre-Auth Increase/Decrease operation.

A Pre-Auth reversal can be used to reverse a capture operation as well. A capture reversal transaction will release all the funds withheld. Reversing a capture operation can only be done before the funds are automatically settled at night, please note that not all acquirers support reversal of captured transactions. If a capture reversal is attempted after the funds have been moved, the operation will receive a decline.

When the capture is reverted it returns to the previous state (CAPTURED -> AUTHORISED).

Parameters

Parameter	Notes
`originalTransactionID` Required String	Transaction id of the original pre-auth or capture GUID transaction
`map` Map	A map including optional transaction parameters.

Code example

// Basic
this.Hapi.PreAuthorizationReversal("00000000-0000-0000-0000-000000000000");

// With options
Dictionary map = new Dictionary();
map.Add(XmlTag.CustomerReference.Tag(), "YourCustomerReference");
map.Add(XmlTag.Metadata1.Tag(), "Data 1");

this.Hapi.PreAuthorizationReversal("00000000-0000-0000-0000-000000000000", map);

Events invoked

This event gets statuses from the payment terminal during the transaction, for example: 'waiting for card' or 'waiting for PIN entry'.

This event is invoked if the card issuer requires the cardholder to sign the transaction receipt.