Healthcare

Healthcare options are available for Converge terminals in the healthcare sector.

Healthcare options are enabled as part of terminal set up. If you would like to enable healthcare options for your site, please contact Support.

In this section:

Supported Transaction Types

Healthcare options are available for the following transaction types.

  • Credit Card Sale - ccsale
  • Credit Card Auth Only - ccauthonly

Healthcare Fields

Healthcare transactions involve the following fields. These fields are only available for terminals with healthcare enabled.

Field nameDescriptionRequiredLengthData type
ssl_healthcare_amountHealthcare Amount
Total amount in a healthcare transaction. ssl_healthcare_amount is equal to ssl_otc_amount + ssl_prescription_amount + ssl_clinic_other_amount + ssl_dental_amount. If this amount is not included in the transaction, then Converge will calculate based off of the other healthcare fields. If you do include this field in the transaction, then Converge will validate the field. If the validation fails, Converge will decline the transaction
optional11numeric
ssl_otc_amountOver the Counter Amount
Amount of over the counter medical expenditures. Defaults to 0.00 if not sent.
optional11numeric
ssl_prescription_amountPrescription Amount
Amount of prescription drug expenditures. Defaults to 0.00 if not sent.
optional11numeric
ssl_clinic_other_amountClinic/Other Amount
Amount of expenditures for clinic or other medical office services. Defaults to 0.00 if not sent.
optional11numeric
ssl_dental_amountDental Amount
Amount of dental expenditures. Defaults to 0.00 if not sent.
optional11numeric
ssl_vision_amountVision Amount
Amount of vision expenditures. Defaults to 0.00 if not sent.
optional11numeric
ssl_transit_amountTransit Amount
Amount of transit expenditures. Defaults to 0.00 if not sent.
Requests that include Transit Amount must be sent separately from healthcare transactions that include other healthcare amount fields.
optional11numeric

Example

Credit Card Purchase

Let’s look at an example scenario for a credit card purchase using Healthcare options.

Request

<txn>
  <ssl_merchant_id>000006</ssl_merchant_id>
  <ssl_user_id>user</ssl_user_id>
  <ssl_pin>GTK8GT</ssl_pin>
  <ssl_transaction_type>CCSALE</ssl_transaction_type>
  <ssl_card_number>4000000000000002</ssl_card_number>
  <ssl_exp_date>1222</ssl_exp_date>
  <ssl_amount>100.00</ssl_amount>
  <ssl_cvv2cvc2_indicator>1</ssl_cvv2cvc2_indicator>
  <ssl_cvv2cvc2>123</ssl_cvv2cvc2>
  <ssl_healthcare_amount>32.00</ssl_healthcare_amount>
  <ssl_prescription_amount>10.00</ssl_prescription_amount>
  <ssl_vision_amount>0.00</ssl_vision_amount>
  <ssl_clinic_other_amount>6.00</ssl_clinic_other_amount>
  <ssl_dental_amount>7.00</ssl_dental_amount>
  <ssl_transit_amount>0.00</ssl_transit_amount>
  <ssl_otc_amount>9.00</ssl_otc_amount>
</txn>

Response

<txn>
  <ssl_issuer_response>00</ssl_issuer_response>
  <ssl_prescription_amount>10.00</ssl_prescription_amount>
  <ssl_card_number>40**********0002</ssl_card_number>
  <ssl_oar_data>010013252602242023060000047730000000000000033759005520132526</ssl_oar_data>
  <ssl_result>0</ssl_result>
  <ssl_txn_id>240220MB-3833177F-27E8-4B57-AC9E-ED436D93C5D1</ssl_txn_id>
  <ssl_avs_response> </ssl_avs_response>
  <ssl_otc_amount>9.00</ssl_otc_amount>
  <ssl_approval_code>033759</ssl_approval_code>
  <ssl_healthcare_amount>32.00</ssl_healthcare_amount>
  <ssl_dental_amount>7.00</ssl_dental_amount>
  <ssl_amount>100.00</ssl_amount>
  <ssl_txn_time>02/24/2020 03:23:06 PM</ssl_txn_time>
  <ssl_exp_date>1222</ssl_exp_date>
  <ssl_card_short_description>VISA</ssl_card_short_description>
  <ssl_card_type>CREDITCARD</ssl_card_type>
  <ssl_clinic_other_amount>6.00</ssl_clinic_other_amount>
  <ssl_transaction_type>SALE</ssl_transaction_type>
  <ssl_transit_amount>0.00</ssl_transit_amount>
  <ssl_account_balance>0.00</ssl_account_balance>
  <ssl_ps2000_data>A0200224152307275031VE</ssl_ps2000_data>
  <ssl_vision_amount>0.00</ssl_vision_amount>
  <ssl_result_message>APPROVAL</ssl_result_message>
  <ssl_cvv2_response>M</ssl_cvv2_response>
  <ssl_partner_app_id>VM</ssl_partner_app_id>
</txn>

Transit Only Transaction

Make requests that include ssl_transit_amount separately from other healthcare amount fields. Requests that include ssl_transit_amount with ssl_otc_amount, ssl_prescription_amount, ssl_clinic_other_amount, ssl_dental_amount, ssl_vision_amount. Transit amount does not add to the total amount calculated for ssl_healthcare_amount.

Request

<txn>
  <ssl_merchant_id>000006</ssl_merchant_id>
  <ssl_user_id>user</ssl_user_id>
  <ssl_pin>GTK8GT</ssl_pin>
  <ssl_transaction_type>CCSALE</ssl_transaction_type>
  <ssl_card_number>4000000000000002</ssl_card_number>
  <ssl_exp_date>1222</ssl_exp_date>
  <ssl_amount>10.00</ssl_amount>
  <ssl_cvv2cvc2_indicator>1</ssl_cvv2cvc2_indicator>
  <ssl_cvv2cvc2>123</ssl_cvv2cvc2>
  <ssl_healthcare_amount>0.00</ssl_healthcare_amount>
  <ssl_transit_amount>10.00</ssl_transit_amount>
</txn>

Response

<txn>
  <ssl_issuer_response>00</ssl_issuer_response>
  <ssl_card_number>40**********0002</ssl_card_number>
  <ssl_oar_data>010013252602242023060000047730000000000000033759005520132526</ssl_oar_data>
  <ssl_result>0</ssl_result>
  <ssl_txn_id>240220MB-3833177F-27E8-4B57-AC9E-ED436D93C5D1</ssl_txn_id>
  <ssl_avs_response> </ssl_avs_response>
  <ssl_approval_code>033759</ssl_approval_code>
  <ssl_healthcare_amount>0.00</ssl_healthcare_amount>
  <ssl_amount>100.00</ssl_amount>
  <ssl_txn_time>02/24/2020 03:23:06 PM</ssl_txn_time>
  <ssl_exp_date>1222</ssl_exp_date>
  <ssl_card_short_description>VISA</ssl_card_short_description>
  <ssl_card_type>CREDITCARD</ssl_card_type>
  <ssl_transaction_type>SALE</ssl_transaction_type>
  <ssl_transit_amount>10.00</ssl_transit_amount>
  <ssl_account_balance>0.00</ssl_account_balance>
  <ssl_ps2000_data>A0200224152307275031VE</ssl_ps2000_data>
  <ssl_result_message>APPROVAL</ssl_result_message>
  <ssl_cvv2_response>M</ssl_cvv2_response>
  <ssl_partner_app_id>VM</ssl_partner_app_id>
</txn>