Create/update individual tariff

The method allows you to create or update an individual tariff.

If a tariff already exists for this userId and action, then the rest of the specified data will overwrite this tariff

Request:

The response contains an array of tariff objects:

Parameter	Type	Description
userId	String	User 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

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

Create/update individual tariff

POSThttps://ocp.onchainpay.io/partner/api/set-organization-tariff

Header parameters

Body

application/json

userIdstring

User ID

Example: "1aff2748-7a08-4d13-b08d-060c9563f3f1"

organizationIdstring

Organization ID

Example: "97bccad1-1028-4773-bd2d-bf3e4e319f6b"

actionenum

Target action on the tariff

Example: "EXCHANGE_AUTO"

INTERNAL_TRANSFERORDER_DEPOSITWALLET_DEPOSITWALLET_WITHDRAWALPAYOUT_DEPOSITPAYOUT_WITHDRAWALPERSONAL_DEPOSITPERSONAL_WITHDRAWALCOLLECT_WITHDRAWALRECURRENT_DEPOSITRECURRENT_WITHDRAWALBRIDGE_INTERNALBRIDGE_EXTERNALEXCHANGE_INTERNALEXCHANGE_AUTOKYT_TRANSACTIONKYT_WITHDRAWAL_ADDRESSKYT_ADDRESSORPHAN_DEPOSIT_WITHDRAWALSEPA_WITHDRAWALSEPA_DEPOSITFIAT_CRYPTO_EXCHANGE

amountstring

The commission percentage of the transaction amount (for example, 0.01 means a commission of 1% of the transaction amount)

Example: "0.03"

typeenum

Type of fare amount

Example: "PERCENT"

PERCENTFIXED

commentstringnull

Tariff Comment

Example: "tariff for John"

minAmountstringnull

Minimum commission for debiting (for example, when performing an operation, 1% of the transaction amount will be debited, but not less than MinAmount)

null - no restrictions

Example: "0.1"

maxAmountstringnull

The maximum commission for debiting (for example, when performing an operation, 1% of the transaction amount will be debited, but no more than MaxAmount)

null - no restrictions

Example: "3000"

Response

200

Body

application/json

success*boolean

Request success indicator

response*CreatePartnerIndividualTariffResponse (null)

The response body of the tariff creation request

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "response": null
}