iPay88 Indonesia - Core API

Selamat datang di laman Core API iPay88 Indonesia.
Segera integrasikan API ini dengan situs Anda untuk memulai transaksi dengan gerbang pembayaran iPay88 Indonesia.

Catatan Penting

1. iPay88 Indonesia belum menyediakan fitur iFrame untuk payment page di laman merchant.
2. Metode CURL tidak dapat digunakan untuk seluruh API iPay88 Indonesia.
3. Lakukan uji transaksi pada fase development atau sandbox terlebih dahulu sebelum memasuki fase production.
4. Pastikan seluruh kode yang Anda tulis telah memenuhi standar pemrograman dan keamanan data.

Online Payment System Gateway Versi 2.1.0

Welcome to iPay88 Indonesia Online Payment Switching Gateway 2.0.X. We provide e-payment services and reports that are integrated with your business site. Merchants can provide various payment methods to customers to make payments directly using our API through iPay88 Indonesia.

Payment Request

Request Parameter

Merchants send parameters via JSON as a request to iPay88 Indonesia. Here are some parameters as a request:

Request Signature

This signature must be included in the request of every transaction and is encrypted using SHA256. This hash signature for a request is a hash of the following five fields:

1. MerchantKey (Provided by iPay88 Indonesia and shared between iPay88 and the merchant only)
2. MerchantCode
3. RefNo
4. Amount
5. Currency

The fields must be set in the following order:
|| MerchantKey || MerchantCode || RefNo || Amount || Currency ||
Example:
MerchantKey = "apple"
MerchantCode = "ID00001"
RefNo = "A00000001"
Amount = "3000" (Note: 3000 represents amount as Rp 3.000)
Currency = "IDR"

The hash would be calculated based on the following string:
||apple||ID00001||A00000001||3000||IDR||
The resulting hash signature value, calculated using SHA256, is:
3ee767e49d29c46b6187db2fe511287ccd986e874a057fa2e1bb222442b68f63

To ensure the signature generated is correct, visit the link below for signature comparison:
Test Signature Comparison

Signature Sample Code

            
              $sha256hex = hash('sha256', "||" . MerchantKey . "||" . MerchantCode . "||" . RefNo . "||" . Amount . "||" . Currency . "||");
            
          

            
              String sha256hex = org.apache.commons.codec.digest.DigestUtils.sha256Hex("||" + MerchantKey + "||" + MerchantCode + "||" + RefNo + "||" + Amount + "||" + Currency + "||");
            
          

Request Sample

            
              {
                "APIVersion": "2.0",
                "MerchantCode": "ID00001",
                "PaymentId": "71",
                "Currency": "IDR",
                "RefNo": "10182019103003AM",
                "Amount": "500000",
                "ProdDesc": "Alat Elektronik",
                "UserName": "Technical Support",
                "UserEmail": "[email protected]",
                "UserContact": "081234567890",
                "Remark": "",
                "Lang": "iso-8859-1",
                "RequestType": "REDIRECT",
                "ResponseURL": "https://sandbox.ipay88.co.id/epayment/fujipaystatusv2.asp",
                "BackendURL": "http://sandbox.ipay88.co.id/ePayment/testing/RequestForm_savetemp.asp",
                "Signature": "b469c7da241554364e55b65ca807ffc501bdf981126c248c636ac9e38592fc12",
                "ItemTransactions": [
                    {
                        "Id": "00001",
                        "Name": "Smartphone Wireless Charger",
                        "Quantity": "1",
                        "Amount": "300000",
                        "Type": null,
                        "Url": null,
                        "ImageUrl": null,
                        "ParentType": "SELLER",
                        "ParentId": "SELLER123"
                    },
                    {
                        "Id": "00002",
                        "Name": "Powerbank 10000maH",
                        "Quantity": "1",
                        "Amount": "200000",
                        "Type": null,
                        "Url": null,
                        "ImageUrl": null,
                        "ParentType": "SELLER",
                        "ParentId": "SELLER123"
                    },
                    {
                        "Id": "shippingfee",
                        "Name": "Shipping Fee",
                        "Quantity": "1",
                        "Amount": "5000",
                        "Type": null,
                        "Url": null,
                        "ImageUrl": null,
                        "ParentType": null,
                        "ParentId": null
                    },
                    {
                        "Id": "discount",
                        "Name": "Discount",
                        "Quantity": "1",
                        "Amount": "5000",
                        "Type": null,
                        "Url": null,
                        "ImageUrl": null,
                        "ParentType": null,
                        "ParentId": null
                    }
                ],
                "ShippingAddress": {
                    "FirstName": "Techsupp",
                    "LastName": "Alpha",
                    "Address": "Jl. Test Blok R No.1",
                    "City": "Jakarta",
                    "State": "DKI Jakarta",
                    "PostalCode": "18800",
                    "Phone": "08123456789",
                    "CountryCode": "1"
                },
                "BillingAddress": {
                    "FirstName": "Techsupp",
                    "LastName": "Alpha",
                    "Address": "Jl. Test Blok R No.1",
                    "City": "Jakarta",
                    "State": "DKI Jakarta",
                    "PostalCode": "18800",
                    "Phone": "08123456789",
                    "CountryCode": "1"
                },
                "Sellers": [
                    {
                        "Id": "SELLER123",
                        "Name": "Sellername",
                        "LegalId": "3274011001900001",
                        "SellerIdNumber": 3274011001900002,
                        "Email": "[email protected]",
                        "Url": "www.sunrise.com",
                        "address": {
                            "FirstName": "Seller",
                            "LastName": "Alpha",
                            "Address": "Jalan Tentara Pelajar no 49",
                            "City": "Jakarta Utara",
                            "State": "DKI Jakarta",
                            "PostalCode": "12960",
                            "Phone": "08123456789",
                            "CountryCode": "IDN"
                        }
                    }
                ],
                "SettingField": [
                    {
                        "Name": "TenorInstallment",
                        "Value": "3"
                    }
                ]
              }
            
          

Response Format

iPay88 Indonesia sends parameters via JSON as a response to Merchant. Here are some parameters as a response:

Response Sample

{
    "RefNo": "920201930925AM",
    "Signature": "b469c7da241554364e55b65ca807ffc501bdf981126c248c636ac9e38592fc12",
    "CheckoutID": "T0036521900",
    "Code": "1",
    "Message": "CheckoutURL generated"
}

    

Response Sample (Virtual Account)

{
    "RefNo": "10182019103003AM",
    "Signature": "b469c7da241554364e55b65ca807ffc501bdf981126c248c636ac9e38592fc12",
    "VirtualAccountAssigned": "21128123123123",
    "TransactionExpiryDate": "18-08-2020 07:57",
    "CheckoutID": "T0036521900",
    "Code": "1",
    "Message": "CheckoutURL generated"
}

    

Response Sample (QRIS)

{
    "RefNo": "920201930911AM",
    "Signature": "6f7a5e4386438adf494feecbdc582d9c81e69e2e5fae747fe9a7dc98ef9fe7f1",
    "VirtualAccountAssigned": "00001234561226610016ID.CO.SHOPEE.WWW01189360091800202690420208202690420303UMI52233123455360540820000.005802ID5920iPay88DummyStore-web6015KOTA JAKARTA PU61051021062150511T03152635123T4C5F11",
    "CheckoutID": "5da812906e2bc26babf28e957c918468d87d34f021cadc66e6bb65c73f9276331",
    "Code": "1",
    "Message": "CheckoutURL generated"
}

    

Payment Redirect

After getting a response from iPay88, merchants need to redirect using the form method POST using CheckoutID from the payment response.

Payment Redirect Parameter

Merchant should configure their server to send Referrer HTTP request header in all their Payment Redirect process to iPay88 payment page. iPay88 will do system verification to make sure that the request is valid from matching Merchant Code and merchant domain URL.
Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer

Payment Redirect Sample

<form method="POST" name="redirect" action="{redirect url}">
    <input type="hidden" name="CheckoutID" value="{CheckoutID}" />
    <input type="hidden" name="Signature" value="{Signature}" />
</form>
<script language="javascript">
    document.redirect.submit();
</script>

            

Payment Response

HTTPS POST redirect response to responseURL (refer to Request Parameter No. 14) from iPay88 OPSG after performing payment.

Payment Response Sample

<%
MerchantCode = Request.Form("MerchantCode")
RefNo = Request.Form("RefNo")
%>
<Add your programming code here>

            

<?PHP
$merchantcode = $_REQUEST["MerchantCode"];
$refno = $_REQUEST["RefNo"];
PHP?>
<Add your programming code here>

            

BackendPost

Backendpost will be sent after a user payment attempt using method POST with type application/json. iPay88 will send a backendpost with 3 times retry until merchant response with Code 1.

For QRIS Static Integration you need to register the merchant BackendURL with iPay88 team in order to receive callback notification.

BackendPost Parameter

BackendPost Signature

This signature must be included in the request of every transaction and encrypted using SHA256. This hash signature for a request is a hash of the following fields:

1. MerchantKey (Provided by iPay88 OPSG and shared between iPay88 and merchant only)
2. MerchantCode (Provided by iPay88 OPSG and shared between iPay88 and merchant only)
3. PaymentID (see References for the list)
4. RefNo
5. Amount
6. Currency
7. TransactionStatus (the status of the transaction can be obtained from iPay88)

The fields must be set in the following order:
|| MerchantKey || MerchantCode || PaymentID || RefNo || Amount || Currency || TransactionStatus ||

Example:
MerchantKey = “apple”
MerchantCode = “ID00001”
PaymentID = “1”
RefNo = “A00000001”
Amount = “3000.47” (Note: 3000.47 represents an amount of Rp 3.000,47)
Currency = “IDR”
TransactionStatus = “1”

The hash would be calculated on the following string:
||apple||ID00001||1||A00000001||3000.47||IDR||1||

The resulting hash signature value (using SHA256 algorithm) is:
ed14e9c0373a1e1f887c29929fd8d063a402f6b1924d78df0763e03bae025ee0

To ensure the signature generated is correct, visit the link below for signature comparison:
https://payment.ipay88.co.id/epayment/testing/TestSignaturev2.asp

BackendPost Signature Sample Code

<?php
$sha256hex = hash('sha256', "||" . MerchantKey . "||" . MerchantCode . "||" . PaymentId . "||" . RefNo . "||" . Amount . "||" . Currency . "||" . TransactionStatus . "||");
?>

            

String sha256hex = org.apache.commons.codec.digest.DigestUtils.sha256Hex("||" + MerchantKey + "||" + MerchantCode + "||" + PaymentId + "||" + RefNo + "||" + Amount + "||" + Currency + "||" + TransactionStatus + "||");

            

BackendPost Sample

{
    "MerchantCode": "ID00001",
    "PaymentId": "118",
    "RefNo": "224202234712AM",
    "Amount": "30000.00",
    "Currency": "IDR",
    "Remark": "",
    "TransId": "T0057525100",
    "AuthCode": "1411600000038796",
    "TransactionStatus": "1",
    "ErrDesc": "",
    "Signature": "e111ac4fae7eeeb07e7b07f0e0b0e6515d3040fe8ac62e0cad5cbe55a48c3fb2",
    "IssuerBank": "",
    "TransactionExpiryDate": "25-02-2022 10:48",
    "VirtualAccountAssigned": "1411600000038796",
    "PaymentDate": "24-02-2022 10:48",
    "Xfield1": "",
    "DCCConversionRate": "0",
    "OriginalAmount": "0.00",
    "DiscountAmount": "",
    "DiscountCode": "",
    "OriginalCurrency": "",
    "SettlementAmount": "0",
    "SettlementCurrency": "",
    "Binbank": ""
}

    

BackendPost Response

Merchant must respond with a specific value of backendpost that is being sent to the merchant's BackendURL.

BackendPost Response Sample

{
    "Code":"1",
    "Message": {
        "English":"Status Received",
        "Indonesian":"Pembayaran diterima"
    }
}

    

Requery Payment Status

Request Parameter

Legend:
M: Mandatory field
O: Optional field, value can be empty but the parameter must exist

Requery Sample

<%
Function SendToiPayInq(byval MerchantCode, byval RefNo, byval Amount)
    Dim TryNo, thenQString, URL, strReturn
    TryNo = 0
    QString = "MerchantCode=" & MerchantCode & "&RefNo=" & RefNo & "&Amount=" & Amount
    URL = "https://payment.ipay88.co.id/epayment/enquiry.asp"
    On Error Resume Next
    Do
        Set xobj = Server.CreateObject ("Msxml2.ServerXMLHTTP.3.0")
        xobj.setTimeouts 30000, 60000, 60000, 60000
        xobj.open "POST", URL, false
        xobj.setRequestHeader "Content-Type", "application/x-www-form-urlencoded"
        xobj.send QString
        TryNo = TryNo + 1
    Loop While xobj.status <> 200 and TryNo < 3
    If xobj.status <> 200 Then
        SendToiPayInq = Err.Description & "(" & Err.Number & ")"
    Else
        SendToiPayInq = xobj.responseText
    End If
    set xobj = nothing
End Function
%>

        

<?PHP
function Requery($MerchantCode, $RefNo, $Amount)
{
    $query = "https://payment.ipay88.co.id/epayment/enquiry.asp?MerchantCode=" . $MerchantCode . "&RefNo=" . $RefNo . "&Amount=" . $Amount;
    $url = parse_url($query);
    $host = $url["host"];
    $path = $url["path"] . "?" . $url["query"];
    $timeout = 1;
    $fp = fsockopen($host, 443, $errno, $errstr, $timeout);
    if ($fp)
    {
        fputs($fp, "GET $path HTTP/1.0\nHost: " . $host . "\n\n");
        while (!feof($fp))
        {
            $buf .= fgets($fp, 128);
        }
        $lines = split("\n", $buf);
        $Result = $lines[count($lines) - 1];
        fclose($fp);
    }
    else
    {
        # enter error handling code here
    }
    return $Result;
}
?>

        

Response Format

Below is iPay88 requery response parameter:

Requery Payment Status v2

Request Parameter

Requery Sample

{
    "RefNo": "1031202241537AM",
    "MerchantCode": "ID00001",
    "Amount": "10000",
    "Signature": "622cbd6690e265cda0371140ee4f21fead6e0ed875f711da28cf08026a0a5617",
    "Currency": "IDR"
}

Response Parameter

Response Sample

{
    "Status": "200",
    "Message": "00",
    "Data": {
        "MerchantCode": "ID00001",
        "PaymentId": "103",
        "RefNo": "113202224101AM",
        "Amount": "10000",
        "Currency": "IDR",
        "Remark": "",
        "TransId": "T0061540600",
        "AuthCode": "879558",
        "TransactionStatus": "1",
        "ErrDesc": "",
        "Signature": "",
        "IssuerBank": "P.T. BANK CIMB NIAGA TBK.",
        "PaymentDate": "03-11-2022 09:43",
        "Xfields1": ""
    }
}

Requery Response Message

Testing Credentials

Uji transaksi dengan metode pembayaran kartu kredit melalui sandbox memerlukan data sampel kartu. Berikut ini adalah testing credentials yang dapat digunakan untuk uji transaksi dengan metode pembayaran kartu kredit.

1. Pengujian Data

2. Pengujian Data Eksespsi

Payment ID

Berikut ini adalah daftar Payment ID iPay88 Indonesia berdasarkan metode pembayaran yang tersedia.

Credit/Debit Card

Online Banking

Virtual Account

Virtual Account Static

E-Wallet

QRIS

Over The Counter

Online Credit

Request Type List

Mata Uang

Berikut ini adalah mata uang yang diharuskan untuk integrasi dengan iPay88 Indonesia.

Deskripsi Error

Berikut ini adalah daftar pesan dan deskripsi error dari iPay88 Indonesia saat integrasi dengan merchant.