(Tcl) Global Payments Card Authorization

Demonstrates how to send a card payments authorization request.

For more information, see https://developer.globalpay.com/#!/api/card-payments#api-authorisation

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# if you don't have a Client ID yet you can still quickly test some basic request types using the following URL and credentials:

# Test URL - https://test.realexpayments.com/epage-remote.cgi
# Client ID: realexsandbox
# Shared Secret: Po8lRRT67a
set testUrl "https://test.realexpayments.com/epage-remote.cgi"
set clientID "realexsandbox"
set sharedSecret "Po8lRRT67a"

set amount "1001"
set currency "EUR"
set cardNumber "4263970000005262"

# We'll be sending the following XML in the body of the request:

# <?xml version="1.0" encoding="UTF-8"?>
# <request type="auth" timestamp="20180613141207">
#   <merchantid>MerchantId</merchantid>
#   <account>internet</account>
#   <channel>ECOM</channel>
#   <orderid>N6qsk4kYRZihmPrTXWYS6g</orderid>
#   <amount currency="EUR">1001</amount>
#   <card>
#     <number>4263970000005262</number>
#     <expdate>0425</expdate>
#     <chname>James Mason</chname>
#     <type>VISA</type>
#     <cvn>
#       <number>123</number>
#       <presind>1</presind>
#     </cvn>
#   </card>
#   <autosettle flag="1"/>
#   <sha1hash>87707637a34ba651b6185718c863abc64b673f20</sha1hash>
# </request>

# Use this online tool to generate code from sample XML: 
# Generate Code to Create XML

# Get the current date/time in this format:  20180613141207
set dt [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dt
set dtStr [CkDateTime_getAsIso8601 $dt "YYYYMMDDhhmmss" 1]

# Generate a unique order ID
set prng [new_CkPrng]

set orderId [CkPrng_genRandom $prng 32 "base64url"]

# Compute the sha1hash
set crypt [new_CkCrypt2]

CkCrypt2_put_HashAlgorithm $crypt "sha1"
CkCrypt2_put_EncodingMode $crypt "hexlower"

set sbA [new_CkStringBuilder]

CkStringBuilder_Append $sbA "timestamp.merchantid.orderid.amount.currency.cardnumber"
set numReplaced [CkStringBuilder_Replace $sbA "timestamp" $dtStr]
set numReplaced [CkStringBuilder_Replace $sbA "merchantid" $clientID]
set numReplaced [CkStringBuilder_Replace $sbA "orderid" $orderId]
set numReplaced [CkStringBuilder_Replace $sbA "amount" $amount]
set numReplaced [CkStringBuilder_Replace $sbA "currency" $currency]
set numReplaced [CkStringBuilder_Replace $sbA "cardnumber" $cardNumber]

set hashA [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbA]]

set sbB [new_CkStringBuilder]

CkStringBuilder_Append $sbB $hashA
CkStringBuilder_Append $sbB "."
CkStringBuilder_Append $sbB $sharedSecret

set hashB [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbB]]

set xml [new_CkXml]

CkXml_put_Tag $xml "request"
CkXml_AddAttribute $xml "type" "auth"
CkXml_AddAttribute $xml "timestamp" $dtStr
CkXml_UpdateChildContent $xml "merchantid" $clientID
CkXml_UpdateChildContent $xml "account" "internet"
CkXml_UpdateChildContent $xml "channel" "ECOM"
CkXml_UpdateChildContent $xml "orderid" $orderId
CkXml_UpdateAttrAt $xml "amount" 1 "currency" $currency
CkXml_UpdateChildContent $xml "amount" $amount
CkXml_UpdateChildContent $xml "card|number" $cardNumber
CkXml_UpdateChildContent $xml "card|expdate" "0425"
CkXml_UpdateChildContent $xml "card|chname" "James Mason"
CkXml_UpdateChildContent $xml "card|type" "VISA"
CkXml_UpdateChildContent $xml "card|cvn|number" "123"
CkXml_UpdateChildContent $xml "card|cvn|presind" "1"
CkXml_UpdateAttrAt $xml "autosettle" 1 "flag" "1"
CkXml_UpdateChildContent $xml "sha1hash" $hashB

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $testUrl [CkXml_getXml $xml] "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkDateTime $dt
    delete_CkPrng $prng
    delete_CkCrypt2 $crypt
    delete_CkStringBuilder $sbA
    delete_CkStringBuilder $sbB
    delete_CkXml $xml
    exit
}

puts "Response Status Code: [CkHttpResponse_get_StatusCode $resp]"

puts "Response Body:"
puts [CkHttpResponse_bodyStr $resp]

if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Failed."
    delete_CkHttp $http
    delete_CkDateTime $dt
    delete_CkPrng $prng
    delete_CkCrypt2 $crypt
    delete_CkStringBuilder $sbA
    delete_CkStringBuilder $sbB
    delete_CkXml $xml
    exit
}

# A status code of 200 indicates we received an XML response, but it could be an error message.
# Here's an example of an error response:

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <response timestamp="20200418142356">
#     <orderid>N6qsk4kYRZihmPrTXWYS6g</orderid>
#     <result>508</result>
#     <message>Invalid timestamp: '{' Value exceeds allowable limit: '}'</message>
# </response>

# We need to check the "result" within the XML.
CkXml_LoadXml $xml [CkHttpResponse_bodyStr $resp]

set result [CkXml_GetChildIntValue $xml "result"]
puts "result = $result"

# A successful result looks like this:

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <response timestamp="20200418145519">
#     <merchantid>realexsandbox</merchantid>
#     <account>internet</account>
#     <orderid>Cw93I1nFWVZuaATh46qMUCBlCcfrOvLo65C2cq5X-AY</orderid>
#     <result>00</result>
#     <authcode>L3pHww</authcode>
#     <message>AUTH CODE: L3pHww</message>
#     <pasref>96838535689610806</pasref>
#     <cvnresult>M</cvnresult>
#     <timetaken>87</timetaken>
#     <authtimetaken>67</authtimetaken>
#     <batchid>6322506</batchid>
#     <sha1hash>2fd2f15f97f1775779fe9bda536dc8317a4b39f6</sha1hash>
# </response>

if {$result == 0} then {
    puts "authcode = [CkXml_getChildContent $xml authcode]"
    puts "Success."

} else {
    puts "Failed."
}

delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkDateTime $dt
delete_CkPrng $prng
delete_CkCrypt2 $crypt
delete_CkStringBuilder $sbA
delete_CkStringBuilder $sbB
delete_CkXml $xml