Developer Docs

Appearance

getServerSettings ​

This method gets current state/settings for interacting with the service. Please always use this method to check:

  • if the feature is available;
  • the minimum and maximum allowed amounts for on-ramp and off-ramp.

🔔

Please note! Financial values are provided and consumed as strings to avoid floating point conversion problems.

Usage ​

typescript
const data = await holyheldSDK.getServerSettings();

Returns ​

typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

isTopupEnabled ​

Indicates if off-ramp is available at the moment

  • Type: Boolean
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean; 
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

isOnRampEnabled ​

Indicates if on-ramp is available at the moment

  • Type: Boolean
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean; 
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

maxTopUpAmountInEUR ​

Maximum amount (equivalent in EUR) that is allowed to be processed

  • Type: String
  • Example: 1000
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string; 
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

minTopUpAmountInEUR ​

Minimum amount (equivalent in EUR) that is allowed to be processed

  • Type: String
  • Example: 5
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string; 
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

maxOnRampAmountInEUR ​

Maximum amount in EUR that is allowed to be processed

  • Type: String
  • Example: 1000
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string; 
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string;
  };
}

minOnRampAmountInEUR ​

Minimum amount in EUR that is allowed to be processed

  • Type: String
  • Example: 5
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string; 
  };
  common: {
    topUpFeePercent: string;
  };
}

topUpFeePercent ​

Fee (in percent) that is deducted when making an off-ramp operation

  • Type: String
  • Example: 0.75
typescript
type ServerExternalSettings = {
  external: {
    isTopupEnabled: boolean;
    isOnRampEnabled: boolean;
    maxTopUpAmountInEUR: string;
    minTopUpAmountInEUR: string;
    maxOnRampAmountInEUR: string;
    minOnRampAmountInEUR: string;
  };
  common: {
    topUpFeePercent: string; 
  };
}