Developers

Overview

The Overview section provides a comprehensive summary of your API usage statistics. This includes key metrics such as Total Requests, Success Rate, Average Response Time, and Error Rate. Additionally, you will find detailed charts illustrating API Usage trends and HTTP Status Code distributions for further analysis.

KeyPair Settings

Generate API/SDK KeyPair

The API/SDK KeyPair is a critical security credential required for integrating with the AkashicPay SDK or SecureAPI:

• When you first onboarded to AkashicPay, you should have already generated your first API/SDK KeyPair.

• This KeyPair is used to authenticate your integration with the AkashicPay SDK or SecureAPI.

• This KeyPair has all the permissions that the Owner KeyPair has, except being able to refresh itself and the Treasury KeyPair.

• To refresh and receive a completely new API/SDK KeyPair:

  1. Navigate to the KeyPair Settings page.

  2. Click the "Refresh KeyPair" button.

  3. Confirm the action when prompted.

Important: There can only be one active API/SDK KeyPair at a time. When you refresh your KeyPair, the previous one immediately becomes invalid and cannot be used. This means you will need to update the KeyPair credentials within your AkashicPay SDK or SecureAPI implementation.

Callback Settings

API Secret

This API Secret is used to verify your webhook signatures. AkashicPay implements a robust security protocol for callback verification to ensure secure communication with Business Partners (BPs). When sending HTTP callbacks, AkashicPay includes a signed signature in the header using an API secret, allowing the BP to confirm the authenticity of the request. BPs can further verify the callback by sending a signed request back to AkashicPay, which then responds with another callback to confirm the verification. This multi-step process, combined with IP whitelisting—where BPs whitelist AkashicPay’s IP addresses—significantly reduces the risk of unauthorized callbacks or attacks from different IP ranges, preventing fraudulent auto-topups on the BP’s platform and ensuring a secure transaction environment.

For more information, please refer to the Secure Callback Endpoint page.

Callback URL Configuration

AkashicPay requires you to provide a callback URL to ensure smooth and efficient communication between your systems and the AkashicPay platform. This URL is essential for receiving notifications about transaction statuses, updates, and other important events related to your account.

Properly configuring the callback URL is crucial for the seamless operation of AkashicPay's services, ensuring that you stay informed and your transactions are processed efficiently.

Note: Deposit callbacks are not sent for Layer 1 deposits with a value less than 1 USDT.

AkashicPay allows you to set the following URLs:

We currently support callback URLs for the following currencies: ETH, TRX, BNB, USDT (ETH), USDT (TRX) and USDT (BNB).

Note: Leaving any callback URL unselected means you will not receive notifications for that type of event. For critical operations, it's recommended to configure all relevant callbacks.

Additional Features

Include Manual Action Callback

When enabled, Deposit and Payout callbacks will be triggered even for transactions made outside SDK or SecureAPI. This will always ensure callbacks are executed to your system. Meaning the deposits and payouts initiated manually will also receive callback in your system.

Relax Matching

When an end client makes a deposit, the actual amount may differ from the requested amount. As a result, the callback we receive may not include a referenceId, since our system fails to match the amounts when they don’t align (see here for more details).

This feature introduces a flexible threshold between the requested and actual deposit amounts, so the end client no longer needs to deposit the exact requested value to receive callbacks between AkashicPay and Business Partner's system.

The default threshold is set to ± 1%, but Business Partners (BPs) can adjust it anywhere between ±1% and 20%.

Example

If an end client requests to deposit 500 USDT but actually deposits 499 USDT, the Relax Matching feature (set to ±1% by default) will still match the deposit. Any amount between 495 USDT and 505 USDT will be accepted and linked with a referenceId.

Deposit Request Expiry Time

By default, the Deposit Request expiry time is set to 24 hours. However, within the AkashicPay dashboard, Business Partners (BPs) have the flexibility to customise this duration. The expiry time can be adjusted to any value ranging from as short as 15 minutes to as long as 24 hours, allowing BPs to define a timeframe that best aligns with their business needs and transaction policies.

Note: A longer expiry time for Deposit Requests means that, within the selected timeframe, an end-client can make deposits and you will receive the funds, the referenceId will be included and amount-matching will be performed for the callback.

After the selected timeframe, an end-client may still deposit and you will still receive the funds, but the referenceId will have expired and no amount-matching will take place.

Best Practices

• Document KeyPair Changes: When refreshing your KeyPairs, ensure all team members are aware of the change to prevent integration issues

• Save Changes: Remember to save after making edits in Additional Features.