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

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

application/json

The body of the request to create an individual tariff

userIdstringOptional

User ID

Example: ff72f744-beda-4cc4-8b44-2b3deb584f99

organizationIdstringOptional

Organization ID

Example: 2a06421c-edae-4df1-9851-17d6479449e2

actionstring · enumOptional

Target action on the tariff

Example: EXCHANGE_AUTOPossible values:

amountstringOptional

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

Example: 0.03

typestring · enumOptional

Type of fare amount

Example: PERCENTPossible values:

commentstring · nullableOptional

Tariff Comment

Example: tariff for John

minAmountstring · nullableOptional

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

maxAmountstring · nullableOptional

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

Responses

200Success

application/json

Successful response

successbooleanRequired

Request success indicator

responsenullRequired

The response body of the tariff creation request

post

/partner/api/set-organization-tariff

HTTPcURLJavaScriptPython

POST /partner/api/set-organization-tariff HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "userId": "ff72f744-beda-4cc4-8b44-2b3deb584f99",
  "organizationId": "2a06421c-edae-4df1-9851-17d6479449e2",
  "action": "EXCHANGE_AUTO",
  "amount": "0.03",
  "type": "PERCENT",
  "comment": "tariff for John",
  "minAmount": "0.1",
  "maxAmount": "3000"
}

200Success

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