card_operation_request

The card_operation_request contains the following data elements:

Field Type Required Description
ped void (error)

if not specified the PED object will be automatically populated.

merchant_account char (tick)

The merchant account processing this transaction. Transactions can be performed with any of the merchant accounts that were returned when registering the POS.

terminal_id char (tick)

The  terminal_id  of the PED.

tender_reference char (tick)

A reference to the tender provided by the PED.

card_type 

char (error) The type of gift card.
card_number String (error)

The gift card number.

Use of this parameter depends on selection of the Manual Keyed Entry option.

expiry_month Long (error)

Month of expiration.

Use of this parameter depends on selection of the Manual Keyed Entry option.

expiry_year Long (error)

Year of expiration.

Use of this parameter depends on selection of the Manual Keyed Entry option.

card_mask char (error)

A mask to validate the correct number of digits to enter.

Use of this parameter depends on selection of the Manual Keyed Entry option.

card_mask_min int (error)

Minimum number of characters in the card mask.

Use of this parameter depends on selection of the Manual Keyed Entry option.

card_mask_max int (error)

Maximum number of characters in the card mask.

additional_data_obj

additional_data_struct

(error)

Contains key/value pairs that can be used by the merchant to return specific additional data, in particular in the final transaction result.

For gift cards, the stored_value_redemption_type additional data key is used for cashback, gratuity and card deactivation.

  • cashback - Cash out the value of a gift card. For SVS, you must create a zero-value transaction to cash out the entire balance of a card. You can not cash out a specific amount.
  • deactivate (not available for SVS) - Deactivates a gift card.
  • gratuity (SVS cards only) - Used to provide a tip from a gift card.
    The cashback and deactivate values can be piped to chain the tasks by passing  "cashback|deactivate".