Get individual tariffs

The method allows you to get all individual tariffs. If an individual tariff is specified for the user, the commission for the specified operation will be charged according to the individual tariff

Request:

Parameter	Обязателен	Type	Description
userId	Yes	String	User ID

Response:

The response contains an array of tariff objects:

Parameter	Type	Description
id	String	Tariff ID
advancedBalanceId	String	Advanced balance ID
action	String	Tariff action
amount	String	The commission percentage of the transaction amount (for example, 0.01 means a commission of 1% of the transaction amount)
minAmount	String or null	The minimum commission for charging (for example, when performing an operation, 1% of the transaction amount will be charged, but not less than minAmount) null - without limits
maxAmount	String or null	The maximum commission for charging (for example, when performing an operation, 1% of the transaction amount will be charged, but no more than maxAmount) null - without limits
comment	String or null	Comment/note for tariff
createdAt	String	Дата создания тарифа
updatedAt	String	Дата обновление тарифа

Parameter action can take the following values:

Tariff	Description
INTERNAL_TRANSFER	Internal transfer
ORDER_DEPOSIT	Accepting payments for order
WALLET_DEPOSIT	Deposit to wallet
WALLET_WITHDRAWAL	Withdrawal from wallet
PAYOUT_DEPOSIT	Deposit to payout balance
PAYOUT_WITHDRAWAL	Withdrawal from payout balance
PERSONAL_DEPOSIT	Deposit to personal address
PERSONAL_WITHDRAWAL	Withdrawal from personal address
COLLECT_WITHDRAWAL	Withdrawal from collect address
RECURRENT_DEPOSIT	Deposit to recurrent address (by periodical subscription)
RECURRENT_WITHDRAWAL	Withdrawal from recurrent address
BRIDGE_INTERNAL	Blockchain bridge (change network)
BRIDGE_EXTERNAL	Blockchain bridge via API
EXCHANGE_INTERNAL	Exchange
EXCHANGE_AUTO	Exchange via API

Get individual tariffs

POSThttps://app.apollopayment.io/partner/api/get-organization-tariffs

Header parameters

Body

application/json

userIdstring

User ID

Example: "162c25fc-2ac4-4672-9248-21bc36b9bc90"

organizationIdstring

Organization ID

Example: "b235973d-cd02-4dc5-94bf-daca0cf85c98"

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetPartnerIndividualTariffsResponse (array of PartnerCustomTariff (object))

The body of the response to receive a list of individual tariffs

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/partner/api/get-organization-tariffs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": [
    {
      "id": "e813eec2-ce6a-490e-b662-25b1306ca255",
      "action": "EXCHANGE_AUTO",
      "amount": "0.03",
      "type": "PERCENT",
      "minAmount": "0.1",
      "maxAmount": "3000",
      "comment": "tariff for John",
      "createdAt": "2024-10-15T16:11:27.530Z",
      "updatedAt": "2024-10-16T16:11:27.530Z"
    }
  ]
}