Replenishment of the user's advance balance

The method allows you to top up the user's advance balance (check the availability of the method in support)

Request:

Parameter	Required	Type	Description
userId	Yes	String	User ID
advancedBalanceId	Yes	String	Advanced balance ID
amount	Yes	String	The amount of replenishment. The number must contain no more than two decimal places (i.e. '5.25' is suitable, but '5.529' is not)

Replenishment of the user's advance balance

post

/partner/api/top-up-advanced-balance

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

userIdstringrequired

User ID

Example: e5c4f95b-dc88-4714-bc81-a31043ae4c8e

organizationIdstringrequired

Organization ID

Example: c134bc01-f3ed-439a-8546-f194a55fa4e6

advancedBalanceIdstringrequired

ID of the advance balance

Example: a2721423-f4dd-400a-bd95-06f246f249a4

amountstringrequired

The amount for which the balance is replenished

Example: 4.87

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/partner/api/top-up-advanced-balance' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "e5c4f95b-dc88-4714-bc81-a31043ae4c8e",
    "organizationId": "c134bc01-f3ed-439a-8546-f194a55fa4e6",
    "advancedBalanceId": "a2721423-f4dd-400a-bd95-06f246f249a4",
    "amount": "4.87"
  }'

200

200

{
  "success": true,
  "response": {
    "advancedBalanceId": "a2721423-f4dd-400a-bd95-06f246f249a4",
    "currency": "USD",
    "blocked": true,
    "balance": "12",
    "blockReason": null,
    "availableCurrenciesForDeposit": [
      "USDT"
    ]
  }
}