API

ICEPAY_CC Class

The ICEPAY_CC class allows you to initiate credit card payments.

Methods

ICEPAY_CC.Pay ( string issuer , string language , string currency , int amount , string description )

Calling the Pay method will return you a URL to the credit card payment screen. You can use this URL to automatically redirect the end-user.

Examples

Below you will find an example of how to initiate a credit card payment. The issuer that will be handling the payment is American Express. The payment screen language is Dutch. The amount to be charged is GBP 4.00.

PHP

    require_once( "icepay.php" );
    $cc = new ICEPAY_CC( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    $url = $cc->Pay( "AMEX", "NL", "GBP", 400, "Example product worth 4 GBP" );
    header( "location: " . $url );
        

C#

    ICEPAY.ICEPAY_CC cc = new ICEPAY.ICEPAY_CC( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    string url = cc.Pay("AMEX", "NL", "GBP", 400, "Example product worth 4 GBP");
    Response.Redirect(url);
        

VB.NET

    Dim cc as new ICEPAY_CC(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ")
    Dim url as string = cc.Pay("AMEX", "NL", "GBP", 400, "Example product worth 4 GBP")
    Response.Redirect(url)
        

ICEPAY_DirectEBank Class

The ICEPAY_DirectEBank class allows you to initiate sofortbanking (Direct E-Banking) payments.

Methods

ICEPAY_DirectEBank.Pay ( string country, string language, string currency, int amount, int string description )

Calling the Pay method will return you a URL to the sofortbanking (Direct E-Banking) payment screen. You can use this URL to automatically redirect the end-user.

ICEPAY_iDEAL Class

The class ICEPAY_iDEAL allows you to easily initiate an iDEAL payment with just a few lines of code.

Remarks: iDEAL only supports the Euro currency and the Dutch language interface. Therefore, you cannot set these two parameters.

Methods

ICEPAY_iDEAL.Pay ( string issuer , int amount , string description )

Calling the Pay method will return you a URL to the iDEAL payment screen. You can use this URL to automatically redirect the end-user to the iDEAL payment screen.

Example

Below you will find an example of how to initiate an iDEAL payment. The issuer that will be handling the payment is the ABN AMRO bank. The amount to be charged is € 5.

PHP

    require_once( "icepay.php" );
    $iDEAL = new ICEPAY_iDEAL( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    $url = $iDEAL->Pay("ABNAMRO", 500, "iDEAL payment of 5 EUR" );
    header( "location: " . $url );
        

C#

    ICEPAY.ICEPAY_iDEAL iDEAL = new ICEPAY_iDEAL(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ");
    String url = iDEAL.Pay("ABNAMRO", 500, "iDEAL payment of 5 EUR");
    Response.Redirect(url);
        

VB.NET

    Dim iDEAL as New ICEPAY.ICEPAY_iDEAL(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ")
    Dim url as String = iDEAL.Pay("ABNAMRO", 500, "iDEAL payment of 5 EUR")
    Response.Redirect(url)
        

ICEPAY_Phone Class

The ICEPAY_Phone class is used to initiate short phone payments.

Methods

ICEPAY_Phone.Pay ( string country , string language , string currency , string amount , string description )

Calling the Pay method will return you a URL to the phone payment screen. You can use this URL to automatically redirect the end-user to the payment screen.

The phone payment method has more restrictions than other payment methods. The following document shows the allowed combinations: ICEPAY Supported Parameters Sheet

Example

PHP

    require_once( "icepay.php" );
    $p = new ICEPAY_Phone( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    $url = $p->Pay( "BE", "EN", "EUR", 125, "Phone payment of 1.25 EUR" );
    header( "location: " . $url );
        

C#

    ICEPAY.ICEPAY_Phone p = new ICEPAY.ICEPAY_Phone(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ");
    string url = p.Pay("BE", "EN", "EUR", 125, "Phone payment of 1.25 EUR");
    Response.Redirect(url);
        

VB.NET

    Dim p as new ICEPAY.ICEPAY_Phone(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ")
    Dim url as string = p.Pay("BE", "EN", "EUR", 125, "Phone payment of 1.25 EUR")
    Response.Redirect(url)
        

ICEPAY_Wire Class

The ICEPAY_Wire class is used to initiate wire transfer payments.

Methods

ICEPAY_Wire.Pay ( string language , string currency , string amount , string description )

Calling the Pay method will return you a URL to the wire transfer payment screen. You can use this URL to automatically redirect the end-user to the payment screen.

Example

In the examples below, we will be initiating a Wire Transfer payment of € 0.30 and redirecting the end-user to the wire transfer payment screen.

PHP

    require_once( "icepay.php" );
    $w = new ICEPAY_Wire( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    $url = $w->Pay( "EN", "EUR", 30, "Wire transfer payment of 0.30 EUR" );
    header( "location: " . $url );
        

C#

    ICEPAY.ICEPAY_Wire w = new ICEPAY.ICEPAY_Wire( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
    string url = w.Pay("EN", "EUR", 30, "Wire transfer payment of 0.30 EUR");
    Response.Redirect(url);
        

VB.NET

    Dim w as new ICEPAY.ICEPAY_Wire(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ");
    Dim url as string = w.Pay("EN", "EUR", 30, "Wire transfer payment of 0.30 EUR");
    Response.Redirect(url);
        

Successful payments

After end-users complete the credit card payment, they will be redirected to a so called Success URL. This is a web page on your website where you should tell your end-users that the payment has been handled successfully. You can set the Success URL in your ICEPAY account.

The following code explains how this works. Calling the OnSuccess method returns True if it is an authentic call from ICEPAY. If so, then you should display your "Thank You" message.

PHP: ok.php

<?php
 
require_once( "icepay.php" );
$icepay = new ICEPAY( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
if ( !$icepay->OnSuccess() ) die();
$data = $icepay->GetData();
 
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
   <title>OK</title>
</head>
<body>
<?php if ( $data->status == "OK" ): ?>
   <h1>Thank You! You have successfully completed the payment!</h1>
<?php endif ?>    
</body>
</html>       
    

C#: ok.aspx

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
    protected void Page_Load(object sender, EventArgs e)
    {
        ICEPAY.ICEPAY ice = new ICEPAY.ICEPAY(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ");
        if (ice.OnSuccess() && ice.GetData().status == "OK")
            pnlThankYou.Visible = true;
    }
</script>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>OK</title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:Panel runat="server" Visible="false" ID="pnlThankYou">
            <h1>Thank You, your order is complete</h1>
        </asp:Panel>
    </form>
</body>
</html>    
    

VB.NET: ok.aspx

<%@ Page Language="vb" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim ice As New ICEPAY.ICEPAY(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ")
        If ice.OnSuccess AndAlso ice.GetData().status = "OK" Then
            pnlThankYou.Visible = True
        End If
    End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>OK</title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:Panel runat="server" Visible="false" ID="pnlThankYou">
            <h1>Thank You, your order is complete</h1>
        </asp:Panel>
    </form>
</body>
</html>    
    

Postback

If your website must act upon a payment status change, e.g. send an e-ticket to your customer if the payment is completed, or update your database, then you must put this business logic in the Postback script. You must never abuse the Success URL or Error URL for this purpose. The latter two are for presentation purposes only!

Many things can happen to a credit card payment. The end-user may initiate a charge back via the credit card company, the payment may be cancelled by the end-user, etc. You should take a look at the list of possible postbacks (See paragraph 5.5.2, page 22).

Your postback script must handle the different types of postback properly. The following code will illustrate this.

PHP: postback.php

<?php
 
require_once( "icepay.php" );
$icepay = new ICEPAY( 10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ" );
if ( $icepay->OnPostback() )
{
   $data = $icepay->GetPostback();
   switch ( strtoupper($data->status) )
   {
      case "OK": // Successful payment
         break;
      case "OPEN": // Payment is not yet completed
         break;
      case "ERR": // Error happened
         break;
      case "REFUND": // Merchant did a refund
         break;
      case "CBACK": // Charge back by end-user
         break;
   }
}
 
?>      
    

C#: postback.aspx

<%@ Page Language="C#" %>
<script runat="server">
    protected void Page_Load(object sender, EventArgs e)
    {
        ICEPAY.ICEPAY ice = new ICEPAY.ICEPAY(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ");
        if (ice.OnPostBack())
        {
            ICEPAY.ICEPAY.Postback data = ice.GetPostback();
            switch (data.status.ToUpper())
            {
                case "OK": // Successful payment
                    break;
                case "OPEN": // Payment is not yet completed
                    break;
                case "ERR": // Error happened
                    break;
                case "REFUND": // Merchant did a refund
                    break;
                case "CBACK": // Charge back by end-user
                    break;
            }
        }
    }
</script>    
    

VB.NET: postback.aspx

<%@ Page Language="vb" %>
<script runat="server">
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim ice As New ICEPAY.ICEPAY(10000, "ABcdEFgHIJklmNOPQrSTUvwXyZ")
        If ice.OnPostBack Then
            Dim data As ICEPAY.ICEPAY.Postback = ice.GetPostback()
            Select Case data.status.ToUpper()
                Case "OK" ' Successful payment
                Case "OPEN" ' Payment is not yet completed
                Case "ERR" ' Error happened
                Case "REFUND" ' Merchant did a refund
                Case "CBACK" ' Charge back by end-user
            End Select
        End If
    End Sub
</script>