UPAYe API



UPAYe APIUPAYe APIUP SolutionConfidential InformationThe information contained in this document is UP Solution’s confidential and has been prepared to establish internal policies and procedures. Distribution of this document outside of UP Solution is strictly prohibited. Do not copy or distribute without the permission of the UP Solution.Document Revision HistoryVersionDateChange1.0.07/18/2014Created.1.1.01/7/2015Added Card Token1.1.13/16/2017Added Integrated Vendor CodeAdded Merchant Email1.1.25/3/2017Removed CardNumber, ExpDate, CardToken from Return transaction (converted to Card NOT Present)Added PurchaseOrderNumber to Sale Transaction1.1.35/17/2017Changed CVV and Billing address to be required (SIM only)Removed BillingProvince, BillingCountry and Fields from UPAYRequestApplied checking duplicated transaction by PurchseOrderNumberAdded PurchaseOrderNumber to UPAYRequest /UPAYResponse1.1.46/26/2017Added UCRefCode to UPAYRequest and UPAYResponseEnabled Return transction with UCRefCodeContents TOC \o "1-4" \h \z \u Purpose PAGEREF _Toc408910654 \h 4API Fields PAGEREF _Toc408910655 \h 4AccessToken PAGEREF _Toc408910656 \h 4? Description PAGEREF _Toc408910657 \h 4CardToken PAGEREF _Toc408910658 \h 4? Description PAGEREF _Toc408910659 \h 4UPAY Request PAGEREF _Toc408910660 \h 5? Description PAGEREF _Toc408910661 \h 5? Fields PAGEREF _Toc408910662 \h 5UPAY Response PAGEREF _Toc408910663 \h 6? Description PAGEREF _Toc408910664 \h 6? Fields PAGEREF _Toc408910665 \h 6API Transactions PAGEREF _Toc408910666 \h 7Sale Transaciton(SIM) PAGEREF _Toc408910667 \h 7? Description PAGEREF _Toc408910668 \h 7? Request PAGEREF _Toc408910669 \h 8? Sample PAGEREF _Toc408910670 \h 8Sale Transaciton(AIM) PAGEREF _Toc408910671 \h 9? Description PAGEREF _Toc408910672 \h 9? Request PAGEREF _Toc408910673 \h 9? Sample PAGEREF _Toc408910674 \h 10Pre-Auth Transaciton PAGEREF _Toc408910675 \h 13? Description PAGEREF _Toc408910676 \h 13? Request PAGEREF _Toc408910677 \h 13? Sample PAGEREF _Toc408910678 \h 13Force Transaciton PAGEREF _Toc408910679 \h 15? Description PAGEREF _Toc408910680 \h 15? Request PAGEREF _Toc408910681 \h 15? Sample PAGEREF _Toc408910682 \h 15Return Transaciton PAGEREF _Toc408910683 \h 17? Description PAGEREF _Toc408910684 \h 17? Request PAGEREF _Toc408910685 \h 17? Sample PAGEREF _Toc408910686 \h 17Void Transaciton PAGEREF _Toc408910687 \h 19? Description PAGEREF _Toc408910688 \h 19? Request PAGEREF _Toc408910689 \h 19? Sample PAGEREF _Toc408910690 \h 19Pre-Auth Completion Transaciton PAGEREF _Toc408910691 \h 21? Description PAGEREF _Toc408910692 \h 21? Request PAGEREF _Toc408910693 \h 21? Sample PAGEREF _Toc408910694 \h 21Register CardToken(SIM) PAGEREF _Toc408910695 \h 23? Description PAGEREF _Toc408910696 \h 23? Request PAGEREF _Toc408910697 \h 23? Sample PAGEREF _Toc408910698 \h 23Register CardToken(AIM) PAGEREF _Toc408910699 \h 24? Description PAGEREF _Toc408910700 \h 24? Request PAGEREF _Toc408910701 \h 24? Sample PAGEREF _Toc408910702 \h 25Sale Transaction with CardToken(SIM) PAGEREF _Toc408910703 \h 26? Description PAGEREF _Toc408910704 \h 26? Request PAGEREF _Toc408910705 \h 26? Sample PAGEREF _Toc408910706 \h 27Sale Transaction with CardToken(AIM) PAGEREF _Toc408910707 \h 28? Description PAGEREF _Toc408910708 \h 28? Request PAGEREF _Toc408910709 \h 28? Sample PAGEREF _Toc408910710 \h 28Manage CardToken(SIM) PAGEREF _Toc408910711 \h 30? Description PAGEREF _Toc408910712 \h 30? Request PAGEREF _Toc408910713 \h 30? Sample PAGEREF _Toc408910714 \h 30Manage CardToken(AIM) PAGEREF _Toc408910715 \h 31? Description PAGEREF _Toc408910716 \h 31? Request PAGEREF _Toc408910717 \h 31? Sample PAGEREF _Toc408910718 \h 32PurposeThis document describes the required steps that must be followed in order to interface UPAYe API.API FieldsAccessToken? Description The unique token to authenticate transactions.The AccessToken is generated using the MD5 hashing algorithm on the following cases. Case 1) UCID|UCPassword|yyyyMMddHHmmssCase 2) UCID|UCPassword|yyyyMMddHHmmss|0.11Case 3) UCID|UCPassword|yyyyMMddHHmmss|0.11|CardTokenCase 4) UCID|UCPassword|yyyyMMddHHmmss||CardToken (Amount is null)CardToken? Description This is value combined with characters and digits(36 length). It is used instand of card information.The CardToken is generated after register card. UPAY Request ? Description <None>? Fields TypeNameDescriptionValueRequiredUCIDUCharge assigned User IDRequiredTimestampThe date and time of AccessToken generation in “MMddyyyy HHmmss”formatRequiredAccessTokenThe AccessToken is generated using the HMAC-MD5 hashing algorithm on the following field values:UCIDUCPasswordTimestampAmount(it may not contain depending on Transaction Type)Field values are concatenated and separated by the “|” characterRequiredResponseTypeA format that represents responseXML, JSON, HTMLConditionalAmountDollar and cents amount of the transaction$0.15 0.15$3.00 3.00ConditionalCardTokenCard identifier token for paymentUp to 36 digits or charactersConditionalApprovalCodeApproval code6 digits or charactersConditionalOrderIDThe unique number ordered through UPAY ServicedigitsConditionalTransactionTypeTransaction type1: Sale2: Pre-Auth3: Force4: Pre-Auth Completion5: Void6: ReturnConditionalCardNumberCard number13-16 digitsConditionalExpDateExpiration DateYYMMConditionalGIDGroup ID assigned by UMSdigitsConditionalEmailCard holder’s email addressOptionalNicknameNickname of cardConditionalCVVThe Card verification?Code (CVV2/CVC2/CID)?3-4 digitsOptionalIsSavedThe field indicate whether save card information.true/falseConditionalBillingAddress1The street address of customer’s billing addressUp to 20 digits or charactersConditionalBillingAddress2The Condominium/Apartment of customer’s billing addressUp to 50 digits or charactersConditionalBillingCityThe city of the customer’s billing addressUp to 50 charactersConditionalBillingStateThe state of the customer’s billing address in USUp to 2 charactersNY: New YorkNJ: New JerseyOptionalBillingProvinceThe province of the customer’s billing addressUp to 50 digits or charactersOptionalBillingCountryThe country of the customer’s billing addressUp to 50 charactersConditionalBillingZipCodeThe ZIP code of the customer’s billing addressUp to 12 digits or charactersOptionalFieldsThe fields present input field on payment form for SIM.Ex) CVV,BillingAddressOptionalIntegratedVendorCodeThe field indicated of the integrated vendor.15 charactersOptionalMerchantEmailThe field present email address to send merchant.Optional PurchaseOrderNumberThe field present the order number from merchant. (used as checking duplicated transaction)Up to 16 charactersConditionalUCRefCodeThe field present transaction reference code under U Charge payment system.Up to 50 charactersUPAY Response? Description <None>? Fields No.NameDescription1UCIDIndicates the type of account being used 2OrderIDUsed to transmit data required for interchange programs.3CardTokenCard identifier token for payment4MaskedCardNumberThe card number masked5MaskedExpDateThe expiration date masked6EntryMethodSwipe, Manual7IsApprovedThe approval status of the transaciotn.Finally, You can recognize whether it has been processed successfully or not.8ApprovalCodeAuthorization code generated by issuer.9CardVerificationResultIndicates the result of the Card Verification Value request10AvsResultCodeThe Address Verification Service (AVS) response code11TransRefCodeThe payment gateway assigned identification number for the transaction12ValidationCodeThe cardholder authentication verification response code13TransactionDateTimeThe date and time of transaction in “MMddyyyy HHmmss”format14TransactionTypeThe type of credit card transaction15AuthorizedAmountAmount returned is the same as the amount submitted.16ReponseMessageA message that represents more details about the result of the transaction17IsValidRequestThe validation status of the request18InvalidFieldsThe fields that requested value is invalid.19GIDGroup ID assigned by UMS20EmailCard holder’s email address21NicknameNickname of card22CardTokenExpDateExpiration date of CardToken formatted “Mmddyyyy”23CardBrandThe brand of credit card24PurchaseOrderNumberSame as requested value25UCRefCodeTransaction reference code under U Charge payment system.API TransactionsSale Transaciton(SIM)? Description The most basic type of card authorization. Applies to most card transactions. ? RequestNameDescriptionMethodGET or POSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterAmountReqiredParameterTransactionTypeReqired1: Sale2: Pre-Auth3: ForceParameterReturnURLReqiredThe URL that is going to be redirected after processing.ParameterIsSavedOptionalParameterFieldsOptionalThe fileds present input field on payment form.Ex) CVV,BillingAddressParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptionalParameterPurchaseOrderNumberOptional? Sample[Request Form]<form method='POST' action='' ><input type='hidden' name='UCID' value='UCID' /><input type='hidden' name='AccessToken' value='Encrypted value by MD5' /><input type='hidden' name='Timestamp' value='08202014 143501' /><input type='hidden' name='Amount' value='0.13' /><input type='hidden' name='TransactionType' value='1' /><input type='hidden' name='ReturnURL' value='' /><input type='hidden' name='IsSaved' value='true' /><input type='hidden' name='Fields' value='CVV,BillingAddress' /><input type='submit' value='Check out' /></form>[Response]HTTP/1.1 302 FoundCache-Control: privateContent-Type: text/html; charset=utf-8Location: : Microsoft-IIS/7.5X-AspNetMvc-Version: 3.0X-AspNet-Version: 4.0.30319X-Powered-By: Date: Wed, 20 Aug 2014 18:47:25 GMTContent-Length: 801Connection: Keep-Alive[Note] Redirect to the ‘ReturnURL’ summited with ‘result’ parameter on the following example. [Encrypted JSON value]You can get the JSON formatted result of transaction by decrypting value for ‘result’ parameter.For example,string?UCPassword?=?" Your password assigned UCharge";string?result =?"The value of parameter’s name ‘result’";string JSON_Formatted_Result = CryptoUtility.Decrypt(UCPassword,?result);For more details please refer to sample code attached.Sale Transaciton(AIM)? Description The most basic type of card authorization. Applies to most card transactions. ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterAmountReqiredParameterTransactionTypeReqired1: Sale2: Pre-Auth3: ForceParameterCardNumberConditional. Required if CardToken is empty.ParameterExpDateConditional. Required if CardToken is empty.ParameterCVVOptionalParameterBillingAddress1OptionalParameterBillingAddress2OptionalParameterBillingCityOptionalParameterBillingStateOptionalParameterBillingProvinceOptionalParameterBillingCountryOptionalParameterBillingZipCodeOptionalParameterIsSavedOptionalParameterCardTokenConditionalRequired if card information is empty.ParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptionalParameterPurchaseOrderNumberOptional? Sample[Request]POST /Sale/PostSale HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 563Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&TransactionType=1&CardNumber=1234567890126781&ExpirationDateMm=11&ExpirationDateYy=10&CVV=111&Subtotal=0.16&Tax=0.02&ShippingAmount=0.08&BillingAddress1=255+S+State+RT+17&BillingAddress2=&BillingCity=Hackensack&BillingState=NJ&BillingZipCode=07601&BillingCountry=US&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{?????UCID:"testid",???OrderID:569,???MaskedCardNumber:"123456XXXXXX6781",???MaskedExpDate:"XXXX",???EntryMethod:"Manual",???IsApproved:true,???ApprovalCode:"MC0026",???CardVerificationResult:"M",???AvsResultCode:"N",???TransRefCode:"MCC2420560806?",???ValidationCode:"e00j",???TransactionDateTime:"20140806101611",???TransactionType:"Sale",???Subtotal:0.16,???Tax:0.02,???ShippingAmount:0.08,???Tip:null,???TotalAmount:0.26,???ReponseMessage:"AP",???IsValidRequest:true,???InvalidFields:null}[Response for invalid request]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{UCID: "",OrderID: 0,MaskedCardNumber: null,MaskedExpDate: null,EntryMethod: null,IsApproved: false,ApprovalCode: null,CardVerificationResult: null,AvsResultCode: null,TransRefCode: null,ValidationCode: null,TransactionDateTime: null,TransactionType: null,Subtotal: null,Tax: null,ShippingAmount: null,Tip: null,TotalAmount: 0,ReponseMessage: null,IsValidRequest: false,InvalidFields: [{FieldName: "UCID",FieldError: "UCID is requied field."},{FieldName: "UCPassword",FieldError: "UCPassword is requied field."},{FieldName: "TotalAmount",FieldError: "Total amount cannot authorize zero amount."},{FieldName: "Subtotal",FieldError: "Subtotal amount must be in the range of $0.01 to $99999.99"},{FieldName: "CardNumber",FieldError: "Card Number must be in the range of 13 to 16 digits."},{FieldName: "ExpirationDate",FieldError: "Invalid expiration date(String was not recognized as a valid DateTime.)"}]}Pre-Auth Transaciton? Description This feature is used to verify funds when the total amount of the purchase is unknown. Please complete this sale by using the Pre-Authorization Completion. ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterAmountReqiredParameterTransactionTypeReqired2: Pre-AuthParameterCardNumberConditional. Required if CardToken is empty.ParameterExpDateConditional. Required if CardToken is empty.ParameterCVVOptionalParameterBillingAddress1OptionalParameterBillingAddress2OptionalParameterBillingCityOptionalParameterBillingStateOptionalParameterBillingProvinceOptionalParameterBillingCountryOptionalParameterBillingZipCodeOptionalParameterIsSavedOptionalParameterCardTokenConditionalRequired if card information is empty.ParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptional? Sample[Request]POST /Sale/PostSale HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 563Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&TransactionType=2&CardNumber=1234567890126781&ExpirationDateMm=11&ExpirationDateYy=10&CVV=111&Amount=0.08&BillingAddress1=255+S+State+RT+17&BillingAddress2=&BillingCity=Hackensack&BillingState=NJ&BillingZipCode=07601&BillingCountry=US&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{?????UCID:"testid",???OrderID:570,???MaskedCardNumber:"123456XXXXXX6781",???MaskedExpDate:"XXXX",???EntryMethod:"Manual",???IsApproved:true,???ApprovalCode:"MC0017",???CardVerificationResult:"M",???AvsResultCode:"N",???TransRefCode:"MCC1410450806?",???ValidationCode:"e00j",???TransactionDateTime:"20140806103147",???TransactionType:"Pre-Authorization",???Subtotal:0.16,???Tax:0.01,???ShippingAmount:null,???Tip:null,???TotalAmount:0.17,???ReponseMessage:"AP",???IsValidRequest:true,???InvalidFields:null}Force Transaciton? Description This feature is used to capture voice-authorized transactions. ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterAmountReqiredParameterApprovalCodeReqiredParameterTransactionTypeReqired3: ForceParameterCardNumberConditional. Required if CardToken is empty.ParameterExpDateConditional. Required if CardToken is empty.ParameterCVVOptionalParameterBillingAddress1OptionalParameterBillingAddress2OptionalParameterBillingCityOptionalParameterBillingStateOptionalParameterBillingProvinceOptionalParameterBillingCountryOptionalParameterBillingZipCodeOptionalParameterIsSavedOptionalParameterCardTokenConditionalRequired if card information is empty.ParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptionalParameterPurchaseOrderNumberOptional? Sample[Request]POST /Sale/PostSale HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 406Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8Origin: : Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedResponseType=JSON&UCID=test&TransactionType=3&ApprovalCode=123456&CardNumber=1234567890126781&ExpirationDateMm=11&ExpirationDateYy=10&CVV=111&Amount=0.17&BillingAddress1=255+S+State+RT+17&BillingAddress2=&BillingCity=Hackensack&BillingState=NJ&BillingProvince=&BillingZipCode=07601&BillingCountry=US&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{?????UCID:"test",???OrderID:571,???MaskedCardNumber:"123456XXXXXX6781",???MaskedExpDate:"XXXX",???EntryMethod:"Manual",???IsApproved:true,???ApprovalCode:null,???CardVerificationResult:null,???AvsResultCode:null,???TransRefCode:"",???ValidationCode:"",???TransactionDateTime:"20140806103925",???TransactionType:"Force",???Subtotal:0.17,???Tax:null,???ShippingAmount:null,???Tip:null,???TotalAmount:0.17,???ReponseMessage:"AP?(OffLine)",???IsValidRequest:true,???InvalidFields:null}Return Transaciton? Description For settled transaction, please use this feature to make a?Refund?to your customer(s).Return amount cannot exceed the original transaction amount. You can refund use without card information. Web UI: ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterAmountReqiredParameterOrderIDReqiredParameterCardNumberConditionalRequired if CardToken is empty.ParameterExpDateConditionalRequired if CardToken is empty.ParameterCardTokenConditionalRequired if card information is empty.ParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptionalParameterPurchaseOrderNumberOptionalParameterUCRefCodeConditionalYou can use instead of OrderID? Sample[Request]POST /Return/PostReturn HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 206Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8Origin: : Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedResponseType=JSON&UCID=test&OrderID=568&CardNumber=1234567890126781&ExpirationDateMm=11&ExpirationDateYy=10&Amount=0.10&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{ UCID:"testid", OrderID:573, MaskedCardNumber:"123456XXXXXX6781", MaskedExpDate:"XXXX", EntryMethod:"Manual", IsApproved:true, ApprovalCode:null, CardVerificationResult:null, AvsResultCode:null, TransRefCode:"", ValidationCode:"", TransactionDateTime:"20140806111014", TransactionType:"Return", Subtotal:0.1, Tax:null, ShippingAmount:null, Tip:null, TotalAmount:0.1, ReponseMessage:"AP (OffLine)", UCRefCode: "124B21028ACFA8456C65A0A4BF041F20", IsValidRequest:true, InvalidFields:null} Void Transaciton? Description You can?Void?any transactions that have not been settled If you already settled a transaction, please use the return sale feature. Web UI: ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterOrderIDReqiredParameterIntegratedVendorCodeOptionalParameterUCRefCodeConditionalYou can use instead of OrderID? Sample[Request]POST /Void/PostVoid HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 57Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&OrderID=569&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 468Connection: Close{ UCID:"testid", OrderID:574, MaskedCardNumber:"123456XXXXXX6781", MaskedExpDate:"XXXX", EntryMethod:"Manual", IsApproved:true, ApprovalCode:null, CardVerificationResult:null, AvsResultCode:null, TransRefCode:"", ValidationCode:"", TransactionDateTime:"20140806111605", TransactionType:"Void", Subtotal:0.16, Tax:0.02, ShippingAmount:0.08, Tip:null, TotalAmount:0.26, ReponseMessage:"AP (OffLine)", UCRefCode: "124B21028ACFA8456C65A0A4BF041F20", IsValidRequest:true, InvalidFields:null} Pre-Auth Completion Transaciton? Description This feature is used to capture a?Pre-Authorized?transaction. Web UI: ? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterOrderIDReqiredParameterIntegratedVendorCodeOptionalParameterPurchaseOrderNumberOptional? Sample[Request]POST /PreAuth/PostCompletion HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 57Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&OrderID=570&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 15:21:22 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 490Connection: Close{ UCID:"testid", OrderID:575, MaskedCardNumber:"549999XXXXXX6781", MaskedExpDate:"XXXX", EntryMethod:"Manual", IsApproved:true, ApprovalCode:null, CardVerificationResult:null, AvsResultCode:null, TransRefCode:"", ValidationCode:"", TransactionDateTime:"20140806112118", TransactionType:"Pre-Authorization Completion", Subtotal:0.16, Tax:0.01, ShippingAmount:null, Tip:null, TotalAmount:0.17, ReponseMessage:"AP (OffLine)", IsValidRequest:true, InvalidFields:null}Register CardToken(SIM)? Description Register card with billing information to obtain CardToken.? RequestNameDescriptionMethodGET or POSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredPlease refer Case 1.ParameterTimestampReqiredParameterGIDReqiredParameterEmailReqiredParameterNicknameOptionalParameterReturnURLReqiredThe URL that is going to be redirected after processing.ParameterIntegratedVendorCodeOptional? Sample[Request Form]<form method='POST' action='' ><input type='hidden' name='UCID' value='UCID' /><input type='hidden' name='AccessToken' value='Encrypted value by MD5' /><input type='hidden' name='Timestamp' value='08202014 143501' /><input type='hidden' name='GID' value='10000' /><input type='hidden' name='Email' value='test@' /><input type='hidden' name='ReturnURL' value='' /><input type='hidden' name='Nickname' value='My Card' /><input type='submit' value='Register' /></form>[Response]HTTP/1.1 302 FoundCache-Control: privateContent-Type: text/html; charset=utf-8Location: : Microsoft-IIS/7.5X-AspNetMvc-Version: 3.0X-AspNet-Version: 4.0.30319X-Powered-By: Date: Wed, 20 Aug 2014 18:47:25 GMTContent-Length: 801Connection: Keep-Alive[Note] Redirect to the ‘ReturnURL’ summited with ‘result’ parameter on the following example. [Encrypted JSON value]You can get the JSON formatted result of transaction by decrypting value for ‘result’ parameter.For example,string?UCPassword?=?" Your password assigned UCharge";string?result =?"The value of parameter’s name ‘result’";string JSON_Formatted_Result = CryptoUtility.Decrypt(UCPassword,?result);For more details please refer to sample code attached.Register CardToken(AIM)? Description Register card with billing information to obtain CardToken.? RequestNameDescriptionMethodPOSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredParameterTimestampReqiredParameterGIDReqiredParameterEmailReqiredParameterNicknameOptionalParameterCardNumberReqiredParameterExpDateReqiredParameterBillingAddress1ConditionalParameterBillingAddress2ConditionalParameterBillingCityConditionalParameterBillingStateConditionalParameterBillingProvinceConditionalParameterBillingCountryConditionalParameterBillingZipCodeConditional? Sample[Request]POST /CardToken/PostRegister HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 563Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&GID=1000&Email=test@&Nickname=TestCard&CardNumber=1234567890126781&ExpDate=1511&BillingAddress1=255+S+State+RT+17&BillingAddress2=&BillingCity=Hackensack&BillingState=NJ&BillingZipCode=07601&BillingCountry=US&AccessToken=[AccessToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{ "UCID":"testid", "OrderID":0, "MaskedCardNumber":"549999XXXXXX6781", "MaskedExpDate":"XXXX", "EntryMethod":null, "CardToken":"7716f00b-e88c-4e4d-84a5-1d721aefe102", "AuthorizedAmount":0, "TransactionDateTime":"01072015 114251", "TransactionType":null, "IsApproved":true, "ApprovalCode":null, "CardVerificationResult":null, "AvsResultCode":null, "TransRefCode":null, "ValidationCode":null, "ReponseMessage":"OK", "IsValidRequest":true, "InvalidFields":null, "GID":"1000", "Email":"test@", "Nickname":"Test card", "CardTokenExpDate":"12032015", "CardBrand":"MASTERCARD"}Sale Transaction with CardToken(SIM)? Description You can?Sale transactions with CardToken you obtained.? RequestNameDescriptionMethodGET or POSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredPlease refer Case 3.ParameterTimestampReqiredParameterTransactionTypeReqired1: SaleParameterAmountReqiredParameterGIDReqiredParameterEmailReqiredParameterCardTokenReqiredParameterReturnURLReqiredThe URL that is going to be redirected after processing.ParameterFieldsOptionalCVVParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptional? Sample[Request Form]<form method='POST' action='' ><input type='hidden' name='UCID' value='UCID' /><input type='hidden' name='AccessToken' value='Encrypted value by MD5' /><input type='hidden' name='Timestamp' value='08202014 143501' /><input type='hidden' name='GID' value='10000' /><input type='hidden' name='Email' value='test@' /><input type='hidden' name='Amount' value='0.13' /><input type='hidden' name='CardToken' value='[CardToken]' /><input type='hidden' name='Fields' value='CVV' /><input type='hidden' name='ReturnURL' value='' /><input type='hidden' name='TransactionType' value='1' /><input type='submit' value='Check out' /></form>[Response]HTTP/1.1 302 FoundCache-Control: privateContent-Type: text/html; charset=utf-8Location: TokenTransaction /Complete?result=4jHm1pIc1SXR2AqsUp8Y%2fEGuY6a%2fKpA6dwFwZiCVZ1iipFz%2fmXgNaa6%2f2h4D7IWrHdRqvUHebGpey%2b23niFHWP1BVnUVpvZSDqhOPt1jx%2ffC4VpUeUmb1gJOekF54ZzSKoZTU1fubfQEKWBvNKmIhta4HKSpXZQoG%2fsKR0kobWs%2brR73kg2Cz%2bKNRVnS5FJF1kxldoQfP%2bqTdiCFAzx%2fLexWK7tLGxMlrPOezjpTvHx54LgoAecIDmwiHMcUV79IfhB5NE6U0h8UFrOG%2fXTuYNfPsKMp3orxFovMMOHdOnYavT3Y%2fZUCXs7Jw4QqTV%2fsNcV1I1okTkTCRoTKQRzirAfR9DuMTSMfBPRQOK%2faRjLW9s0N%2bcYgBxYKKGb1HUCNmuXplf%2bPeUSKWpIlQBpWDrzjAtwHQXTWflkP5WIwzV5XXZN4yguMO6NYcRGpj7kiUnuUWddFjf2QcZ7LWYeysTbrGxkl08HiVxuyxLxAlNTzOi0EPKIsAUgj1YF7mXNTFycbDjAeXWk8kRhN3htR9WIkTmFT6yTzbayPfKd5jYQCtXocBWK2HOQVUs5l%2bAXv%2bzaSShsgVco%3dServer: Microsoft-IIS/7.5X-AspNetMvc-Version: 3.0X-AspNet-Version: 4.0.30319X-Powered-By: Date: Wed, 20 Aug 2014 18:47:25 GMTContent-Length: 801Connection: Keep-AliveSale Transaction with CardToken(AIM)? Description You can?Sale transactions with CardToken you obtained.? RequestNameDescriptionMethodPOSTURL, JSONParameterUCIDReqiredParameterAccessTokenReqiredPlease refer Case 3.ParameterTimestampReqiredParameterCardTokenReqiredParameterGIDReqiredParameterEmailReqiredParameterAmountReqiredParameterTransactionTypeReqired1: SaleParameterCVVOptionalParameterIntegratedVendorCodeOptionalParameterMerchantEmailOptionalParameterPurchaseOrderNumberOptional? Sample[Request]POST /CardToken/PostRegister HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 563Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&GID=1000&Email=test@&Amount=0.08&TransactionType=1&CVV=111&AccessToken=[AccessToken]&CardToken=[CardToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{ "UCID":"test", "OrderID":1360, "MaskedCardNumber":"549999XXXXXX6781", "MaskedExpDate":"XXXX", "EntryMethod":"Manual", "CardToken":"b0253182-ac98-47b3-b098-d90ba4f25196", "AuthorizedAmount":0.77, "TransactionDateTime":"01072015 150132", "TransactionType":"Sale", "IsApproved":true, "ApprovalCode":"MC0077", "CardVerificationResult":"M", "AvsResultCode":"N", "TransRefCode":"MCC0132640107 ", "ValidationCode":"e00j", "ReponseMessage":"AP", "IsValidRequest":true, "InvalidFields":null, "GID":"1000", "Email":"test@", "Nickname":"Test card", "CardTokenExpDate":"12082015", "CardBrand":"MASTERCARD"}Manage CardToken(SIM)? Description You can?modify status of CardToken or Card Expiration Date, Nickname.? RequestNameDescriptionMethodGET or POSTURL, JSON, HTMLParameterUCIDReqiredParameterAccessTokenReqiredPlease refer Case 4.ParameterTimestampReqiredParameterGIDReqiredParameterEmailReqiredParameterCardTokenReqiredParameterReturnURLReqiredThe URL that is going to be redirected after processing.? Sample[Request Form]<form method='POST' action='' ><input type='hidden' name='UCID' value='UCID' /><input type='hidden' name='AccessToken' value='Encrypted value by MD5' /><input type='hidden' name='Timestamp' value='08202014 143501' /><input type='hidden' name='GID' value='10000' /><input type='hidden' name='Email' value='test@' /><input type='hidden' name='CardToken' value='[CardToken]' /><input type='hidden' name='ReturnURL' value='' /><input type='submit' value='Manage CardToken' /></form>[Response]HTTP/1.1 302 FoundCache-Control: privateContent-Type: text/html; charset=utf-8Location: TokenTransaction /Complete?result=4jHm1pIc1SXR2AqsUp8Y%2fEGuY6a%2fKpA6dwFwZiCVZ1iipFz%2fmXgNaa6%2f2h4D7IWrHdRqvUHebGpey%2b23niFHWP1BVnUVpvZSDqhOPt1jx%2ffC4VpUeUmb1gJOekF54ZzSKoZTU1fubfQEKWBvNKmIhta4HKSpXZQoG%2fsKR0kobWs%2brR73kg2Cz%2bKNRVnS5FJF1kxldoQfP%2bqTdiCFAzx%2fLexWK7tLGxMlrPOezjpTvHx54LgoAecIDmwiHMcUV79IfhB5NE6U0h8UFrOG%2fXTuYNfPsKMp3orxFovMMOHdOnYavT3Y%2fZUCXs7Jw4QqTV%2fsNcV1I1okTkTCRoTKQRzirAfR9DuMTSMfBPRQOK%2faRjLW9s0N%2bcYgBxYKKGb1HUCNmuXplf%2bPeUSKWpIlQBpWDrzjAtwHQXTWflkP5WIwzV5XXZN4yguMO6NYcRGpj7kiUnuUWddFjf2QcZ7LWYeysTbrGxkl08HiVxuyxLxAlNTzOi0EPKIsAUgj1YF7mXNTFycbDjAeXWk8kRhN3htR9WIkTmFT6yTzbayPfKd5jYQCtXocBWK2HOQVUs5l%2bAXv%2bzaSShsgVco%3dServer: Microsoft-IIS/7.5X-AspNetMvc-Version: 3.0X-AspNet-Version: 4.0.30319X-Powered-By: Date: Wed, 20 Aug 2014 18:47:25 GMTContent-Length: 801Connection: Keep-AliveManage CardToken(AIM)? Description You can?modify status of CardToken or Card Expiration Date, Nickname.? RequestNameDescriptionMethodPOSTURL, JSONParameterUCIDReqiredParameterAccessTokenReqiredPlease refer Case 4.ParameterTimestampReqiredParameterCardTokenReqiredParameterGIDReqiredParameterEmailReqiredParameterStatusReqired ACTIVE, INACTIVE, DELETE, UPDATEParameterExpDateConditionalIf Status is ‘UPDATE’, This field could be required.ParameterNicknameConditionalIf Status is ‘UPDATE’, This field could be required.? Sample[Request]POST /CardToken/PostManage HTTP/1.1Host: upaye.Connection: keep-aliveContent-Length: 563Cache-Control: max-age=0Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36Content-Type: application/x-www-form-urlencodedAccept-Encoding: gzip,deflate,sdchAccept-Language: en-US,en;q=0.8,ko;q=0.6,zh-CN;q=0.4,zh;q=0.2ResponseType=JSON&UCID=test&GID=1000&Email=test@&Status=UPDATE&ExpDate=1612&AccessToken=[AccessToken]&CardToken=[CardToken][Response]HTTP/1.1 200 OKServer: Development Server/11.0.0.0Date: Wed, 06 Aug 2014 14:31:50 GMTX-AspNet-Version: 4.0.30319X-AspNetMvc-Version: 3.0Cache-Control: privateContent-Type: application/json; charset=utf-8Content-Length: 484Connection: Close{ "UCID":"test", "OrderID":0, "MaskedCardNumber":"549999XXXXXX6781", "MaskedExpDate":"XXXX", "EntryMethod":null, "CardToken":"b0253182-ac98-47b3-b098-d90ba4f25196", "AuthorizedAmount":0, "TransactionDateTime":"01082015 162114", "TransactionType":null, "IsApproved":true, "ApprovalCode":null, "CardVerificationResult":null, "AvsResultCode":null, "TransRefCode":null, "ValidationCode":null, "ReponseMessage":"OK", "IsValidRequest":true, "InvalidFields":null, "GID":"1000", "Email":"test@", "Nickname":"This is my Test Card", "CardTokenExpDate":"12132016", "CardBrand":"MASTERCARD"} ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download