Supporting regional payment flows

The Remote Pay SDKs support regional payment flow differences with parameters specific to each region. These parameters are passed as key-value pairs in SaleRequest, AuthRequest, and PreAuthRequest.

Regional parameters for Argentina

Clover devices in Argentina display two additional screens during the default payment flow: the fiscal invoice and installment screens.

The following table describes the parameters specific to Argentine flows. The names are constants defined in the RegionalExtras class.

NameDescription
FISCAL_INVOICE_NUMBER_KEYNumber associated with the transaction. Valid invoice numbers are four digits, one dash, then eight more digits with no spaces (dddd-dddddddd).
INSTALLMENT_NUMBER_KEYThe number of payment installments. If passed a number, the installments screen is skipped. If no number is passed, the installments screen appears and prompts the customer for a selection.
INSTALLMENT_PLAN_KEYThe name (or other identifier) of the payment plan. The value must be a number between 1-99.
SKIP_FISCAL_INVOICE_NUMBER_SCREEN_VALUEPass this value to FISCAL_INVOICE_NUMBER_KEY to skip the invoice screen without using an invoice number
INSTALLMENT_NUMBER_DEFAULT_VALUEDefault value for INSTALLMENT_NUMBER_KEY which can be used skip the installment screen.

This sample shows a SaleRequest which skips both the fiscal invoice and installment screens by using the SDK-provided values for FISCAL_INVOICE_NUMBER_KEY and INSTALLMENT_NUMBER_KEY.

private saleRequest setupSaleRequest() {
  SaleRequest saleRequest = new SaleRequest();
  saleRequest.setExternalId(ExternalIdUtils.generateNewID()); //required
  Map<String, String> extras = new HashMap<>();
  extras.put(RegionalExtras.FISCAL_INVOICE_NUMBER_KEY, RegionalExtras.SKIP_FISCAL_INVOICE_NUMBER_SCREEN_VALUE);
  extras.put(RegionalExtras.INSTALLMENT_NUMBER_KEY, RegionalExtras.INSTALLMENT_NUMBER_DEFAULT_VALUE);
  saleRequest.setRegionalExtras(extras);
}