Ruby Requires Chilkat v11.0.0+

CardConnect Signature Capture

See more CardConnect Examples

Demonstrates how to upload a BMP image of a handwritten signature.

This signature capture service augments an existing authorization record with the provided signature data. ...

See https://developer.cardconnect.com/cardconnect-api?lang=json#signature-capture

Ruby

require 'chilkat'

success = false

#  This example assumes the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("API_USERNAME")
http.put_Password("API_PASSWORD")

#  Build and send the following JSON:

#  {
#    "merchid": "MERCHANT_ID",
#    "retref": "112989260941",
#    "signature": "BASE64_GZIPPED_BMP_DATA"
#  }

json = Chilkat::CkJsonObject.new()
json.UpdateString("merchid","MERCHANT_ID")
json.UpdateString("retref","106631225001")

#  Load the .bmp containing a 200px x 100px signature.
bd = Chilkat::CkBinData.new()
success = bd.LoadFile("qa_data/bmp/signature.bmp")
#  Gzip compress.
gzip = Chilkat::CkGzip.new()
success = gzip.CompressBd(bd)
#  Add to the JSON in base64 format
json.UpdateString("signature",bd.getEncoded("base64"))

url = "https://<site>.cardconnect.com:<port>/cardconnect/rest/sigcap"

resp = Chilkat::CkHttpResponse.new()
success = http.HttpStr("PUT",url,json.emit(),"utf-8","application/json",resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

#  A response status of 200 indicates potential success.  The JSON response body
#  must be examined to determine if it was truly successful or an error.
print "response status code = " + resp.get_StatusCode().to_s() + "\n";

jsonResp = Chilkat::CkJsonObject.new()
jsonResp.Load(resp.bodyStr())
jsonResp.put_EmitCompact(false)

print "response JSON:" + "\n";
print jsonResp.emit() + "\n";

#  A successful response looks like this:

#  {
#    "resptext": "signature stored",
#    "retref": "106631225001",
#    "respcode": "02",
#    "merchid": "MERCHANT_ID"
#  }