CARDIPAY DOCUMENTATION ENGLISH

Size: px

Start display at page:

Download "CARDIPAY DOCUMENTATION ENGLISH"

Shanon Riley
6 years ago
Views:

1 CARDIPAY DOCUMENTATION ENGLISH

2 1 Account Profile 2 Technical Guide Documentation Content 2.1 How to initiate the payment Using the POST Method Using the GET Method 2.2 The Return of information (after payment made ) Example of PHP script for a Back Url 3 Automatic confirmation (optional) 4 Subscription option (for monthly automatic payment collection) 4.1 Installation 5 TEST Mode 4.2 Create monthly subscription 4.3 Admin Panel 4.4 Stop Monthly Subscription 6 Consistency Verification (optional) 7 Contact Our Support Team Documentation technique BLUEPAID

3 Account Profile You can access your admin panel through the following link: You will be prompted to enter your login (id_boutique) and password. Once logged in please click on My account. Now you will be able to fill up all the fields with the information that we need to run your merchant account. The following information will be required: Name of your shop/website. First and last name of the owner. address. Website addresses URL. (where the products/services are sold) Phone number. Fax number. Complete address. Zip Code. City. Country. This information are the ones you provided to us on your registration but if needed you can update /change them anytime. Referring URL(s) Please specify the referring URL from witch the payments will be generated. If more than one URL is used you will need to separate the urls with the ; sign. ex : ( Logo URL Ex : (do not put the Please verify the URL you are submitting and make sure the image file is one of the following types:.jpg/.jpeg/.gif/.png. Customized Text (optional) for the first page of the payment Ex : Welcome on our secured payment page for mywebsite.com. Please fill up the information on our secure form. Translations of the text in other languages. Customized text (optional) for the validation page Ex : Please click on the link «Back» and I will send you your file/product Translations of the text in other languages Back URL after a transaction is validated. Do not put the Back URL if the transaction is stopped or canceled before payment is made Do not put the Confirmation URL (Optional) Would like us to ask the client fill up a form with his personal details?. Select Yes if you want the client to fill up a form with his credit card info Font Color. Select or enter the hexadecimal color for the font of the payment page. Background Color. Same as font color. Once you filled up the entire information click on SAVE.

4 TECHNICAL GUIDE To ensure a proper communication of information between your website and Cardipay.com system, you will have to follow the following directions. These are the information you can give to your webmaster/programmer to set up cardipay payment on your website: 1. How to initiate a payment: POST Method HTML example on how to send a client to your secure payment page <html> <head> <title>test on how to initiate a payment</title> <meta http-equiv="content-type" content="text/html; charset=iso "> </head> <body bgcolor="#ffffff"text="#000000"> <form method="post" action=" <input type="hidden" name="id_boutique" value="xxxxxxxxxx"> <input type="hidden" name="id_client" value="xxxxxxxxxx"> <input type="hidden" name="montant" value="xxxxx,xx"> <input type="hidden" name="devise" value="xxx"> <input type="hidden" name="langue" value="xx"> <input type="hidden" name="divers" value="xxxxxxxxxx"> <input type="submit" name="submit" value="envoyer"> </form> </body> </html> GET Method How to initiate a payment with a simple URL (Get) <a> href=" &id_client="xxxxxxxxx"&montant="xxxx,xx"&devise="xx"&langue="xx" &divers="xxxxxxx">test Initiate Payment: Payment Page </a>

5 Possible values for the variables : Variable name Value Information id_boutique id_client Montant This information is provided to you by Cardipay and you id_boutique is actually your login to your admin panel. Can be composed by figures and letters, 100 characters maximum. You can use this variable to identify your client or invoice number. Amount of the transaction, it has to be entered in this form: XXXXX,XX or XXXXX.XX devise langue Devise is for the currency EUR CHF USD GBP JPY CAD AUD FR EN IT DE ES PT NL For Euro For Franc Suisse For US Dollar For British Pound For Yen For Canadian Dollar For Australian Dollar For French For English For Italian For German For Spanish For Portuguese For Dutch _client pays_liv (optional) Your client s , so that he will not need to retype it again The county ISO code for the Shipping address of your client This information is very important is you want to use the Consistency Verification tool

6 2. The return of information (after payment made) You can collect and use the information that Cardipay sends you back in any language of your choice. You will find here under a example of a PHP page designed to receive back the information from cardipay system once the payment is done. This example is only valid only if the PHP is configured with register_globals = Off. If you are using register_globals = On, you will have to use the superglobal Tables to access the variables. Variables that are sent back to your website by Cardipay : means that Cardipay system will be sending back the exact content of the variable that your website sent at the first place to Cardipay payment page. Variable name id_boutique id_client montant devise langue divers Value Information id_trans XXXXX-XXXXX This is the transaction ID number, it is composed by the day, the year, and the day transaction position. date_trans jj/mm/aaaa DD/MM/YYYY date of the transaction hh:mm:ss Time of the transaction attente On Hold: In case a credit card information is save but not yet processed Etat stop ok ko In case the transaction is abandoned or canceled. Ok means the card can be charged (valid) Ko means the card can not be charged

7 Example of Back URL Page ( PHP Script ) <html> <head> <title>back page after payment</title> <meta http-equiv="content-type" content="text/html; charset=iso "> </head> <body bgcolor="#ffffff" text="#000000"> <p>back from the payment page</p> <p> </p> <table width="760" border="0" cellspacing="0" cellpadding="0"> <td>id boutique</td> <td><?=$id_boutique?></td> <td>id_client</td> <td><?=$id_client?></td> <td>amount </td> <td><?=$montant?></td> <td>currency</td> <td><?=$devise?></td> <td>language</td> <td><?=$langue?></td> <td>transaction ID</td> <td><?=$id_trans?></td> <td>transaction date</td> <td><?=$date_trans?></td> <td>miscellaneous</td> <td><?=$divers?></td> <td>status :</td> <td><?=$etat?></td> </table> </body>

8 AUTOMATIC CONFIRMATION Cardipay Documentation The automatic confirmation will enable you to automatically confirm your order s payments or member status in your database. This confirmation is done by Cardipay system sending you variables and information to the URL of your choice. Cardipay sends you the information in 2 steps: 1. Just after the client validates the payment, Cardipay sends you the variable etat = attente». Attente means on hold. You can save your client order. 2. Between 5 seconds to 1 minute the transaction is processed and you receive the status of the transaction: «etat = ok» or «etat = ko». You can mark your client s order as paid (ok) or payment refused (ko). This will enable you to update your database and mark the payment as made/successful. To be able to use this function you will need to fill up the field "Confirmation URL" in your Account Profile. The Confirmation URL must be reachable through a web browser so that Cardipay can access it and transmit the information directly to it. (Do not protect this file or URL with a password) Cardipay System will send back the following information to your Confirmation URL: Transaction (one time payment) : Variable name id_client Value Information etat Ok Payment accepted Ko Payment rejected Attente On hold, the payment is not yet processed. Annu Transaction canceled thus rejected Id_trans This is the transaction ID number, it is composed by the day, the year, and the day transaction position mode test If you are using a credit card testing montant Amount of the transaction devise Currency: divers Miscellaneous: langue Language

9 Transaction for a monthly subscription : Variable name Value Information id_client etat ok Payment accepted ko Payment refused annu Transaction canceled or refused id_trans Transaction ID Type redebit Value that marks the payment as a monthly subscription Num_abo : Subscription number mode test If you are using a credit card testing montant Amount of the transaction devise Currency: divers langue Miscellaneous: Language For the first transaction of a Monthly subscription : Variable name periodicite nb_redebit Information Frequency of payments Number of charges (how many times the card will be charged) Stop a monthly subscription : Variable Name Value Information id_client etat fini Status of the subscription type abonnement Subscription type num_abo Subscription reference number langue Language selected * The variables are sent back using the POST method to your back URL(s).

10 Subscription Option Installation : The subscription type of payments works exactly the same way as a normal one time payment works except that there are 3 more variables to use: type : unique value => abonnement Sample of code : <input type="hidden" name="type" value="abonnement"> periode :c This is the period or frequency of the reccuring billings Values => XXj (for days) or XXm (for months) (ex 15j for 15 days or 12m for 12 months) Sample of code : <input type="hidden" name="periode" value="15j"> nb_redebit : Total number of times that the card will be billed. Possible values XX or x (small letter) Example 12 for 12 billings of the card, or x for unlimited billings (as long as the client does not stop it). Sample of code : <input type="hidden" name="nb_redebit" value="12"> Subscription process : The client subscribes using the form on the Cardipay secure page, the first transaction is charged and the subscription is effective. The client receives an notification of his payment and then the other confirmation is sent to the shop owner. Once the period of time between 2 billings is passed a new transaction is processed, and so on until the maximum number or transaction is reached, or it will go on processing recurring payments if it s unlimited recurring transactions. Every time a subscription is stopped both the merchant/shop and the client receive a notification.

11 Administration panel : In your admin panel you will find a link for Subscriptions type of transactions that will allow you to view your ongoing (active), stopped or Test subscriptions The status finish will end the subscription but will keep a track of the transactions and history of this subscription. If a client stops his subscription then the status will become finish. Un-subscription process : If you want to implement a UN-subscribe option directly into you website to allow your clients to stop their subscription through their member panel on your website, you can use the following process: Send a query on the following URL: And send us the following variables: id_boutique : Your id_boutique The address that the client used to subscribe. num_abo : The subscription reference number. If these 3 information match then it will return the status OK and in the next minute the subscription will be stopped If the 3 information/variables do not match, our system will return the status: ko.

TEST PROCESS WITH RETURN OF VARIABLES On top of the normal TEST mode we have an additional way for you to test the implementation of Cardipay in your system using the return of information to your

12 TEST PROCESS WITH RETURN OF VARIABLES On top of the normal TEST mode we have an additional way for you to test the implementation of Cardipay in your system using the return of information to your Back Urls You can do Test transactions even if your account is already activated. To do Test transaction you simply have to use the following special credit card test information: Will return "ok" (payment accepted) Will return "ko" (payment refused) Will return "annu" (transaction canceled) For the Expiry date just add one month to today date. For the CVV2 please use: 123 In test mode, the notifications are sent, the confirmation Back Urls will receive the return of information from Cardipay, and just the final status of the transaction will be marked as test CONSISTENCY VERIFICATION (optional) If you are using the Consistency Verification you can enhance the result of this verification by sending us the country of your client To do so, you have to send us the ISO code of the country of your client, it is composed with 3 characters (example: FRA for France, BEL for Belgium etc ) You have to send this information as a value of the following variable name: pays_liv in the same way you send the other variables. CONTACT OUR SUPPORT TEAM Please us at contact@cardipay.com

Subscriptions and Recurring Payments Guide

Subscriptions and Recurring Payments Guide For Professional Use Only Currently only available in English. A usage Professional Uniquement Disponible en Anglais uniquement pour l'instant. Last Updated: