Aman iOS SDK

Aman SDK will allow your iOS application to:

• initiates full-screen activities to get the shipping address, method of shipping, and payment information.
• Card, reference code, and installment payment options are easily obtained from Aman.

Make sure you are satisfied with the following compatibility list in order to prevent any conflicts and ensure a smooth integration.

To ensure that the SDK is integrated and prepared for use in your application logic, please adhere to the steps listed below.

1. Download Aman Android SDK.
2. After downloading the framework file, extract it, copy it to your project folder, and add it to the build phase settings.

3. Import the main header file:

#import <AmanBusinessFramework/AmanBusinessFramework.h>

It's time to learn how to use our SDK API hooks after integrating Aman SDK in order to:

1. Create payment order.
2. Handling payment result.
3. Order status query.

dictionary data should be implemented by your app cart item; the values that need to be passed through your dictionary object are shown in the table below.

Create dictionary data as below.

NSDictionary *dic=@{
    @"merchantName": merchantName,
    @"country": country,
    @"reference": reference,
    @"amount": @{
        @"total": payAmount,
        @"currency": currency
    },
    @"product": @{
        @"name": productName,
        @"description": productDescription
    },
    @"returnUrl": returnUrl,
    @"callbackUrl": callbackUrl,
    @"cancelUrl": cancelUrl,
    @"userClientIP":userClientIP,
    @"expireAt":@([expireAt integerValue])
};

Now, you need to initialize the management class. Code example as follows:

[[[AmanOrderRequestManager instance]registerApp:publickey MerchantId:merchantId isDebug:_isDebug]

To begin creating an order, you must call the AmanOrderRequestManager management class after initializing the management class. You can use the sample code that follows.

[[AmanOrderRequestManager instance] sendOrder:dic successHandler:^(id  _Nonnull result) {
   //Success callback
} errorHandler:^(NSString * _Nonnull code, NSString * _Nonnull msg) {
 //error message callback
 } failHandler:^{
  //failed callback
}];

failHandler: Handle the logic for the callback after the service fails to be called.

successHandler: For the callback after the service is called successfully, the callback parameter result is the result returned by the calling service. The type is a dictionary and contains order information. Sample response is given below:

{
    code = 00000;
    data =     {
        amount =         {
            currency = EGP;
            total = 1000;
        };
        cashierUrl = "https://sandboxcashier.Amancheckout.com/checkout-list?orderNo=211026140930379662&merchantId=256621050820270&country=EG&rc=false";
        orderNo = 211026140930379662;
        reference = 12347544444555666llljhh;
        status = INITIAL;
        vat =         {
            currency = EGP;
            total = 0;
        };
    };
    message = SUCCESSFUL;
}

You should build some logic deal with any errors that a request or the system may return, depending on the status code of the response. The list of potential error codes that you might see is provided below.

Aman server will respond back to the SDK to let you know the payment processing result, Once the payment has been completed by your client. Following your client's payment completion, you will receive the payment processing result as a JSON object. :

Sample response Json object.

{
    callbackName = clickReferenceCodeReturnBtn;
    eventName = clickReferenceCodeReturnBtn;
    merchantId = 256621050820270;
    orderNo = 211026140930379662;
    orderStatus = PENDING; // INITIAL - SUCCESS - FAIL - CLOSE
    payNo = 211026140930379662;
    referenceCode = 607943772;
}

The order status might not be available on time due to network and other problems. To make sure your data is accurate, it is highly recommended that you call order status inquiry. Consequently, you will have to make a dictionary with the following request parameters in it:

NSDictionary *dic=@{
    @"country": countryCode,
    @"reference": reference,
    @"orderNo":orderNo
};

Following the creation of the query dictionary, the management class needs to be initialized as follows:

[[[AmanOrderRequestManager instance]registerApp: privateKey MerchantId:merchantId isDebug:_isDebug]

Now, you need to :

[AmanOrderRequestManager instance] queryOrder:dic successHandler:^(NSString * _Nonnull code, NSString *
                        _Nonnull errorMsg, id  _Nonnull result) {
                } failHandler:^{
}];

failHandler: Handle the logic for the callback after the service fails to be called.

successHandler: For the callback after the service is called successfully, the callback parameter result is the result returned by the calling service. The type is a dictionary and contains order status information. Sample response is given below:

{
"code": "00000",
"message": "SUCCESSFUL",
"data":{
    "reference":"1001000",
    "orderNo":"10212100000034000",
    "status":"SUCCESS",
    "vat":{
      "total":10000,
      "currency":"EGP",
      "rate":100,
      "currencySymbo":"ج.م"
    },
    "failureReason":null,
    "silence":"Y"
}

You should include some logic to handle any errors that a request or the system may return, depending on the status code of the response. Below is a list of potential error codes that you might encounter.