getDepositUrl

Get a URL with deposit-addresses for all possible networks for a given identifier

Given a user-identifier, this function will create wallets on all supported networks via AkashicChain for the user to deposit into, and return a URL to display them

• If you want to track an individual deposit made to any of the generated address, include referenceId

• If the URL should only display a select choice of currencies, include them in a list as receiveCurrencies

  • If you want to change the type of currencies at a later time, just re-generate the URL via the SDK using the same parameters (but different receiveCurrencies ).

• If you want precisely specify the amount that should be deposited for tracking purposes, perhaps in a different currency than the deposit will be made in (even fiat), include requestedAmount and requestedCurrency . See more here

Example

Get deposit URL for user123

TypeScript

const depositUrl = await akashicPay.getDepositUrl(
  'user123'
);

// with referenceId
const depositUrl = await akashicPay.getDepositUrl(
  'user123', 'order1'
);

// with receiveCurrencies
const depositUrl = await akashicPay.getDepositUrl(
  'user123', 'order1', [Currency.USDT]
);

// with requestedAmount and requestedCurrency
const { address, identifier } = await akashicPay.getDepositUrlWithRequestedValue(
  'user123', 'order1', Currency.USD, "1000"
);

PHP

$depositUrl = $akashicPay->getDepositUrl(
  'user123'
);

// with referenceId
$depositUrl = $akashicPay->getDepositUrl(
  'user123', 'order1'
);

// with receiveCurrencies
$depositUrl = $akashicPay->getDepositUrl(
  'user123', 'order1', array(CurrencySymbol::USDT)
);

// with requestedAmount and requestedCurrency
$depositAddress = $akashicPay->getDepositUrlWithRequestedValue(
  'user123', 'order1', Currency::USD, 1000
);

Java

APDepositUrlResult depositAddress = akashicPay.getDepositUrl(
  'user123'
);

// with referenceId
APDepositUrlResult depositAddress = akashicPay.getDepositUrl(
  'user123', 'order1'
);

// with receiveCurrencies
APDepositUrlResult depositAddress = akashicPay.getDepositUrl(
  'user123', 'order1', {APCurrencySymbol.USDT}
);

// with requestedAmount and requestedCurrency
APDepositAddressResult depositAddress = akashicPay.getDepositUrlWithRequestedValue(
  'user123', 'order1', APCurrency.USD, 1000
);

C#

var depositUrl = await akashicPay.GetDepositUrlAsync("user123");

// with referenceId
var depositUrl = await akashicPay.GetDepositUrlAsync("user123", "order1");

// with receiveCurrencies
var depositUrl = await akashicPay.GetDepositUrlAsync("user123", "order1", {APCurrencySymbol.USDT});

// with requestedAmount and requestedCurrency
var depositUrl = await akashicPay.GetDepositUrlWithRequestedValueAsync("user123", "order1", Currency.USD, 1000);

Example deposit URL/QR code view for end-client