Areeba Gateway Integration

Step 1

Step 2

Step 3

Step 4

Full-Page Redirect

This flow requires you to redirect the end-user to the payment page as advised in the redirectUrl response.

Initiate the payment with the appropriate API call
Upon success the Gateway answers with a result containing returnType = REDIRECT and the url in redirectUrl.
You redirect the user to the given URL (usually via a Location header)
The user completes the payment process on the payment page
The Gateway sends an asynchronous status notification to the URL provided in the initial API call
The user will be back redirected to the successUrl or errorUrl (depending on the result) you provided in the initial API call.

Credit Card

Use the below test card to test your integration.

Card Number:

Expiry Date:

Security Code:

Cardholder Name:

Request format

POST

https://gateway.areebapayment.com/api/v3/transaction/{yourApiKey}/debit

Requests to the Transaction API are sent via HTTPS containing a JSON body.

The server accepts TLS version >= 1.2 connections.
Content-Type must be application/json
Authentication credentials are sent via BASIC Auth (see below)
The submerchant details should be modified

Authentication

The API username and password must be sent as BASIC Authentication in the Authorization header (refer to RFC 7617).

Username and password are concatenated by a : (colon) and the whole string is Base64 encoded.

Username is anyApiUser, password is myPassword
Concatenation is anyApiUser:myPassword
Base64 encoded: YW55QXBpVXNlcjpteVBhc3N3b3Jk
The passed header will then look like this: Authorization: Basic YW55QXBpVXNlcjpteVBhc3N3b3Jk

Request Sample

    {
        "merchantTransactionId": "{YOUR_TRANSACTION_ID}",
        "amount": "9.99",
        "currency": "USD",
        "successUrl": "http://example.com/success",
        "cancelUrl": "http://example.com/cancel",
        "errorUrl": "http://example.com/error",
        "callbackUrl": "http://example.com/callback",
        "customer": {
          "firstName": "John",
          "lastName": "Doe",
          "email": "john@example.com",
          "company": "Big Company Inc.",
          "ipAddress": "127.0.0.1"
        },
        "language": "en"
    }

Response Sample

    {
        "success":true,
        "uuid":"3a2a25ea35b27e585d8a",
        "purchaseId":"20220707-3a2a25ea35b27e585d8a",
        "returnType":"REDIRECT",
         "redirectUrl":"https:\/\/gateway.areebapayment.com\/redirect\/3a2a25ea35b27e585d8a\/Y2Q2M2RlODM1NmExNDAyZWRlMmUyYjZhYjU0MTRiYTQ3Yjg2NDAxZjM4YzFjNzhiNjkyMTM2OTEyZmE3ZDhjNTA5NTY1YzIyN2U0NzRmM2NlMWM0NWU5MWE1NGM2ZTgxMzVjNzhmMWM1NDJkNThiNjgzMjRmYzczM2MwNzFjYjI=",
        "paymentMethod":"Creditcard"
    }

Thank you Page

When returning to merchant website (in successUrl element)

At this step, make a request to "Retrieve order" and check for the result of payment

GET

https://gateway.areebapayment.com/api/v3/status/{yourApiKey}/getByMerchantTransactionId/{YOUR_TRANSACTION_ID}

Response

{
    "transactionStatus": "SUCCESS",
    "success": true,
    "uuid": "f5e7748ff18d00278f4f",
    "merchantTransactionId": "Trans-64a2d4a681807",
    "purchaseId": "20230703-f5e7748ff18d00278f4f",
    "transactionType": "DEBIT",
    "paymentMethod": "Creditcard",
    "amount": "9.99",
    "currency": "USD",
    "customer": {
        "firstName": "John",
        "lastName": "Doe",
        "company": "Big Company Inc.",
        "ipAddress": "127.0.0.1"
    },
    "returnData": {
        "_TYPE": "cardData",
        "type": "mastercard",
        "cardHolder": "John Doe",
        "expiryMonth": "01",
        "expiryYear": "2039",
        "binDigits": "51234500",
        "firstSixDigits": "512345",
        "lastFourDigits": "0008",
        "fingerprint": "cBrui/YdKyHl/aheGojRbfslNwsp7eKPMGb/6e2LTkSISpMykxeuhtuIhWAb5zV0Hj3EnPYJ+IK0AnYWaCdOCA",
        "threeDSecure": "MANDATORY",
        "eci": "02",
        "binBrand": "MASTERCARD",
        "binBank": "Afriland First Bank ",
        "binType": "CREDIT",
        "binLevel": "STANDARD",
        "binCountry": "LR"
    }
}

Areeba Gateway Integration

Full-Page Redirect

Credit Card

Request format

Authentication

ACS emulator

At this step, just press submit

Thank you Page

When returning to merchant website (in successUrl element)

At this step, make a request to "Retrieve order" and check for the result of payment

Areeba Gateway Integration

Full-Page Redirect

Credit Card

Request format

Authentication

ACS emulator

At this step, just press submit

Thank you Page

When returning to merchant website (in successUrl element) At this step, make a request to "Retrieve order" and check for the result of payment

When returning to merchant website (in successUrl element)

At this step, make a request to "Retrieve order" and check for the result of payment