Signature - ccsignature
This section describes the message parameters for Credit Card Signature transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ccsignature transaction adds signature data to a previously approved Credit Card Sale (ccsale), Auth Only (ccauthonly), or Force (ccforce) transaction.
error_outline
note
- Signature is not allowed for the eCommerce market segment.
- Signature can only be added to a transaction that has no signature.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
Request
| Field name | Description | Required | Length | Data type |
|---|---|---|---|---|
ssl_merchant_id | Merchant ID Elavon-assigned Converge Account ID (AID). | Required | 6 or 7 | numeric |
ssl_user_id | Converge user ID The user ID with Hosted Payment API user status that can send transaction requests through the terminal. | Required | 15 | alphanumeric |
ssl_pin | Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. The ssl_user_id sending the transaction request must be associated with the terminal that will process the request. | Required | 64 | alphanumeric |
ssl_transaction_type | Transaction Type Valid value: ccsignature | Required | 20 | alphanumeric |
ssl_txn_id | Transaction ID Unique identifier of the previously approved Sale ( ccsale), Auth Only (ccauthonly), or Force (ccforce) transaction. | Required | 46 | alphanumeric |
ssl_signature_image | Signature Image Digital version of the cardholder’s signature. | Required | BLOB | Base64 Encoded |
ssl_image_type | Signature Image Format File format of the signature image. Valid values: GIF, TIF, JPG, PNG | Required | 3 | alphanumeric |
Response
| Field name | Description |
|---|---|
ssl_result | Signature Request Result Codessl_result = 0 indicates that the signature was uploaded and added.An ssl_result = 1 indicates that the signature was not uploaded and added. |
ssl_result_message | Signature Upload Result Message A result of SUCCESS indicates that the signature image was uploaded or added. A result of ERROR indicates that the signature image was not uploaded or added. |
ssl_user_id | Converge User ID |
| [Error] | Returned only if an error occurs. Refer to the Error Codes section for more information. |
errorCode | Error Code Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field. |
errorMessage | Error Message Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface. |
errorName | Error Name Error name or reason for the error. |
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.
Approved Sale Transaction
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_test_mode>false</ssl_test_mode>
<ssl_transaction_type>ccsale</ssl_transaction_type>
<ssl_amount>1.00</ssl_amount>
<ssl_track_data>%B0000000000000000^NOVA CORPORATION^2212101543213961456?;0000000000000000=2212101543213961456?</ssl_track_data>
</txn>
Response
<txn>
<ssl_approval_code>N21032</ssl_approval_code>
<ssl_cvv2_response />
<ssl_exp_date>1222</ssl_exp_date>
<ssl_departure_date />
<ssl_account_balance>0.00</ssl_account_balance>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_invoice_number />
<ssl_amount>1.00</ssl_amount>
<ssl_result>0</ssl_result>
<ssl_txn_id>AA49315-DCA463E6-F924-4CA8-9FBF-01220FBACA19</ssl_txn_id>
<ssl_card_number>00**********0000</ssl_card_number>
<ssl_completion_date />
<ssl_txn_time>01/28/2022 10:21:31 PM</ssl_txn_time>
<ssl_avs_response />
</txn>
Add Signature to Approved Sale Transaction
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_description>Keyed Sale API</ssl_description>
<ssl_transaction_type>ccsignature</ssl_transaction_type>
<ssl_txn_id>AA49315-DCA463E6-F924-4CA8-9FBF-01220FBACA19</ssl_txn_id>
<ssl_signature_image>SIGNATURE_IMAGE</ssl_signature_image>
<ssl_image_type>PNG</ssl_image_type>
</txn>
Response
<txn>
<ssl_transaction_type>CCSIGNATURE</ssl_transaction_type>
<ssl_user_id>my_user_id</ssl_user_id>
<ssl_result>0</ssl_result>
<ssl_result_message>SUCCESS</ssl_result_message>
</txn>