Unified API for Redirect or IFRAME billing form ( API 10) EN

מספר מאמר: AA-00412 צפיות: 13025 נוצר: 18/02/2015 15:33 עדכון אחרון: 02/08/2018 13:01

0 דירוג/ מצביע

שפות לדף פרופיל נמוך redirect / Iframe - Languages

Unified API for Redirect or IFRAME billing form( API 10)

This API allows you to :

Billing credit card.
Billing and creating a token - token is used for recurring billing.
Only creating a token- use for token creation without billing the credit card.
suspended deal- allows to suspend the credit card charge and to charge it in the cardcom website interface in a later date.

API Name to Value

Name to Value address is: https://secure.cardcom.solutions/Interface/LowProfile.aspx

Important notes Name to Value:

Request must be a made in POST action.
All the values must be URL encoded.
The parameter codepage=65001 is a required parameter. it tells the system the type of URL decoding in this case Unicode.
The response is in Name to Value format for example: ResponseCode=4&Description=NoPemition&LowProfileCode=601.

General notes:

The response parameter LowProfileCode is a type of GUID fix length of 36. you need to save it attached to the order.
ResponseCode different then 0 means developer error you need to alert the system adimistrator with the description and the ResponseCode.
Low profile code is valid for 15 minutes from its creation , you can change the expiration form the terminal back office.

parameters table :

Parameter	Description	exempla values
Operation	The operation that the page need to preform : 1- billing only 2 - billing and token creation 3 - token creation only 4- suspended deal note the for operations for token and suspended deal have additional parameters.	1
TerminalNumber	the terminal that need to preform the action	1000
UserName	API User Name	SFDS342FSSDF
SumToBill	the sum to bill and to show to the user	100.56
CoinID	billing coin	1 : NIS 2 : USD Other by ISO currency List Other Currency
Language	page language	he - Hebrew en - English ru - Russian ar - Arabic Other languages
ProductName	product name to shoe to the user , only displayed if no invoice request is made.	ORDER ID : C101G
APILevel	API Level need to be 10	10
MaxNumOfPayments	The max number of payment that the user can select	32
MinNumOfPayments	The min number of payment that the user can select	3
HideCreditCardUserId	Hide User ID	false
SuccessRedirectUrl	The page that the card owner will be redirected to after a successful deal if the page in an IFrame , the link needs to be in https not http Must external address, not localhost	http://www.site.com/Success.html
ErrorRedirectUrl	The page that the card owner will be redirected to after a failed deal if the page in an IFrame , the link needs to be in https not http* Must external address, not localhost	http://www.site.com/Error.html
IndicatorUrl	A notify url . the cardcom system will preform a synchronize GET request to this page ( before we redirect the card holder to the success URL ). Your site need to preform a request to Cardcom servers to know if the transaction use a success. Must external address, not localhost see : articale XXXX	http://www.stie.com/hide.aspx
CancelUrl	Cancel button URL if the page in an IFrame , the link needs to be in https not http	http://www.site.com/Cart.aspx
CancelType	Cancel button Type	0 - Don't Show 2 - Redirect to CancelUrl
SumInStars	Sum to bill in stars	0
HideCVV	Hide CVV input box from form	false
CreditType	Notes for Payment in Credit : 1. for Credit billing the min number of payments is 3 - the system will auto change it. 2. There is minimum sum for credit billing you need to verify it	1 - Regular billing 6 - Payment Credit billing. .
ReturnValue	A value that will be saved in CardCom system. it is possible to receive the value using Notify URL	1234
DefaultNumOfPayments	the default number of payment the the user will see	10
HideCardOwnerName	Is to hide card owner name string	true to hide , else show
SapakMutav	code ravmutav	1234
RefundDeal	do a refund deal - active on Operation billing only	ture
ShowCardOwnerPhone	show card owner phone text box	true
ReqCardOwnerPhone	is card owner phone text box required	false
ShowCardOwnerEmail	show card owner email text box	true
ReqCardOwnerEmail	is card owner phone text box required	true
ShowInvoiceHead	Show and allow Edit of all InvoiceHead Information to the card owner	true

Additional optional params for Operation 2 - Create token only and 3 -Billing and Create token

Parameter	Description	exempla values
CreateTokenDeleteDate	Whan to remove the token and the card number for cardcom system	01/01/2025
CreateTokenJValidateType	Type of test to be performed on the card J2- Testing only told criticism of the card. J5 - Test and booking of the transferred amount. you will recive One-time confirmation code. The confirmation code need to be transpfer to cardcom systems when billing should be done. Using J5 subject to approval of credit card company. Parameter obtained approval will be show in Indicator ( Notify) URL : TokenApprovalNumber	2 for J2 test , 5 for J5 test

Additional optional params for Operation 4 - suspended deal.

Parameter	Description	exempla values
SuspendedDealJValidateType	Type of test to be performed on the card J2- Testing only told criticism of the card. J5 - Test and booking of the transferred amount. Using J5 subject to approval of credit card company.	2 for J2 test , 5 for J5 test
SuspendedDealGroup	Group code - used to display in the CardCam back office	0

The response you will get after ending the params to the site :

Parameter	Description	exempla values
ResponseCode	response code	0 - OK else a developer error
Description	response code description	OK
LowProfileCode	unique code for this deal. you need to save it in your data base on the order for futer user query	8b0fd17a-d103-4c18-ab3b-f9c0f24f57f8
url	the url to redirect or to iframe to the card owner	https://secure.cardcom.solutions/SomePage.aspx

After you get ResponseCode = 0 you need to redirect ( or Iframe) the user to the url.

See attach file for code exemle. you need to ask support for user name and password for tesing.

Parameters table for more languages

קבצים מצורפים

Uni_Interface_Iframe_And_Invoice.php.txt

4.1 Kb

הורדת קובץ

הערות

אין הערות למאמר זה.