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)
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
The body of the request for replenishment of the advance balance
userIdstringRequiredExample:
User ID
6fb8b0d7-c40e-4692-ad85-b5f2208c2f78
organizationIdstringRequiredExample:
Organization ID
2497027d-1f9c-46e1-92cf-76f7b046305e
advancedBalanceIdstringRequiredExample:
ID of the advance balance
b40d8a13-82b6-4d11-9b44-e09cf8a4c1b1
amountstringRequiredExample:
The amount for which the balance is replenished
4.87
Responses
200Success
application/json
post
POST /partner/api/top-up-advanced-balance HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 180
{
"userId": "6fb8b0d7-c40e-4692-ad85-b5f2208c2f78",
"organizationId": "2497027d-1f9c-46e1-92cf-76f7b046305e",
"advancedBalanceId": "b40d8a13-82b6-4d11-9b44-e09cf8a4c1b1",
"amount": "4.87"
}
200Success
{
"success": true,
"response": {
"advancedBalanceId": "b40d8a13-82b6-4d11-9b44-e09cf8a4c1b1",
"currency": "USD",
"blocked": true,
"blockReason": null,
"balance": "12",
"availableCurrenciesForDeposit": [
"USDT"
]
}
}
Last updated