1. One-time Payment Page

A one-time payment page is the easiest way to collect payments without performing any code related integrations on your website. The one-time payment page can be accessed by a link which you can share with your customers via email, WhatsApp, Twitter or any medium of your choice. This link is also unique to your business, and all your customer has to do is open it and pay you. Take the following steps to create a one-time payment page:

• Login to the ARAKA Merchant Portal with the account you created
• Navigate to Payment Pages located on the sidebar to the left of the screen
• Click on “New Page”
• From the option modal that appears, select “One-time Payment”
• Fill in the details that are required and click “Create Page”
• On the “Payment Page” screen (see Figure 4) you will see the page you just created.
• Click on “View” to see the details of the payment page you just created.
• Copy the Payment Page URL and share to your customers.

2. API Integration

For Merchants who prefer to use plain old API requests, there is the possibility of using our API.

The API requires a bearer token that can be obtained by using our login endpoint. Subsequent requests should always include this bearer token in the Authorization header of the request.

A swagger page containing postman collections can always be obtained here:

2.2 Payment Request

This endpoint allows the caller to request payments from a payee.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Payment Request Flow:

The table below provides information about the properties expected in the payload to be sent to this request:

{
  "order": {
    "paymentPageId": "string",
    "customerFullName": "string",
    "customerPhoneNumber": "string",
    "customerEmailAddress": "string",
    "transactionReference": "string",
    "amount": 0,
    "currency": "string",//USD,CDF
    "redirectURL": "string"
  },
  "paymentChannel": {
    "channel": "string", //MOBILEMONEY,CARD
    "provider": "string", //MPESA,AIRTEL,ORANGE, AFRIMONEY
    "walletID": "string" //MSISDN
  }
}

{
  "transactionId": "string",
  "originatingTransactionId": "string",
  "statusCode": "202",
  "statusDescription": "ACCEPTED"
}

A private key shall be shared with the integrator on request to use in the decryption of the callback message. The signature of the payload shall be passed in the header of the response with the Key: X-APP-SIGNATURE. The following is an example of how to verify the payload with the signature in C#:

public static bool VerifyCallback(string receivedPayload, string receivedSignature, string sharedSecretKey)
{
    byte[] keyBytes = Encoding.UTF8.GetBytes(sharedSecretKey);
    byte[] payloadBytes = Encoding.UTF8.GetBytes(receivedPayload);
    byte[] signatureBytes = Convert.FromBase64String(receivedSignature);

    using (var hmac = new HMACSHA256(keyBytes))
    {
        byte[] calculatedHash = hmac.ComputeHash(payloadBytes);

        // Compare the calculated hash with the received signature
        return CryptographicOperations.FixedTimeEquals(calculatedHash, signatureBytes);
    }
}

{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusCode”:”200”,
  “statusDescription”:”string”, //APPROVED,DECLINED,PENDING
}

2.3 Status Inquiry

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats

Where xxxx is the transactionId received in the transaction request

{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusDescription”:”string”, //APPROVED,DECLINED,PENDING
  “statusCode”:”200”
}

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats

Where xxxx is the transactionReference sent in the original transaction request

{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “status”:”string”, //APPROVED,DECLINED,PENDING
  “statusCode”:”200”,
  “transactionDate”:”string”

}