Printer Setup - printersetup

The printersetup transaction retrieves the printer information.

In this section:

Request

ssl_merchant_id
15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
ssl_user_id
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin
64 | alphanumeric | required
Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
ssl_transaction_type
20 | alphanumeric | required
Transaction Type
Value: printersetup

Response

error_outline
note

The response contains the root XML beginning and ending element <txn>.

PrinterOptions
 
Printer Options
  • PrinterType - Printer Type
  • PaperType - Type of Paper
ReceiptHeaderOptions
 
Receipt Header Options
  • Justification - Alignment of header on the receipt
  • HeaderLine1 - First Line of the Header
  • HeaderLine2 - Second Line of the Header
  • HeaderLine3 - Third Line of the Header
  • HeaderLine4 - Fourth Line of the Header
  • HeaderLine5 - Fifth Line of the Header
ReceiptTrailerOptions
 
Receipt Trailer or Footer Options
  • Justification - Alignment of trailer or footer
  • TrailerLine1 - First Line of the Trailer or Footer
  • TrailerLine2 - Second Line of the Trailer or Footer
  • TrailerLine3 - Third Line of the Trailer or Footer
  • TrailerLine4 - Fourth Line of the Trailer or Footer
  • TrailerLine5 - Fifth Line of the Trailer or Footer
ReceiptCustomFields
 
Receipt Custom Fields
  • CustomLabel1 - First custom field label to appear on the receipt.
  • CustomField1 - First custom field to appear on the receipt.
  • CustomLabel2 - Second custom field label to appear on the receipt.
  • CustomField2 - Second custom field to appear on the receipt.
  • CustomLabel3 - Third custom field label to appear on the receipt.
  • CustomField3 - Third custom field to appear on the receipt.
  • CustomLabel4 - Fourth custom field label to appear on the receipt.
  • CustomField4 - Fourth custom field to appear on the receipt.
  • CustomLabel5 - Fifth custom field label to appear on the receipt.
  • CustomField5 - Fifth custom field to appear on the receipt.

Example

error_outline
important
  • In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

xmldata=<txn><ssl_merchant_id>my_merchant_id</ssl_merchant_id>
<ssl_user_id>my_user_id</ssl_user_id>
<ssl_pin>my_pin</ssl_pin>
<ssl_transaction_type>printersetup</ssl_transaction_type></txn>

Response

<txn>
    <PrinterOptions>
        <PrinterType>Serial Printer</PrinterType>
        <PaperType>Multi Ply</PaperType>
    </PrinterOptions>
    <ReceiptHeaderOptions>
        <Justification>Center</Justification>
        <HeaderLine1>RECEIPT LINE 1</HeaderLine1>
        <HeaderLine2>RECEIPT LINE 2</HeaderLine2>
        <HeaderLine3>RECEIPT LINE 3</HeaderLine3>
        <HeaderLine4>RECEIPT LINE 4</HeaderLine4>
        <HeaderLine5>RECEIPT LINE 5</HeaderLine5>
    </ReceiptHeaderOptions>
    <ReceiptTrailerOptions>
        <Justification>Center</Justification>
        <TrailerLine1>RECEIPT LINE 6</TrailerLine1>
        <TrailerLine2>RECEIPT LINE 7</TrailerLine2>
    </ReceiptTrailerOptions>
    <ReceiptCustomFields>
        <CustomLabel1>Custom Field</CustomLabel1>
        <CustomField1>MyCustom</CustomField1>
        <CustomLabel2 />
        <CustomField2 />
        <CustomLabel3 />
        <CustomField3 />
        <CustomLabel4 />
        <CustomField4 />
    </ReceiptCustomFields>
</txn>