Getting the user's advance balances
The method allows you to get user's advanced balances
Request:
Parameter
Required
Type
Description
userId
Yes
String
User ID
Response:
Parameter
Type
Description
advancedBalanceId
String
Advanced balance ID
currency
String
Currency
balance
String
Balance
availableCurrenciesForDeposit
Array of strings
Array of currencies available to deposit to the advance balance
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 receiving advance balances
userIdstringRequiredExample:
User ID
6fb8b0d7-c40e-4692-ad85-b5f2208c2f78
organizationIdstringOptionalExample:
ID of the created organization
2497027d-1f9c-46e1-92cf-76f7b046305e
Responses
200Success
application/json
post
POST /partner/api/get-organization-advanced-balances HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"userId": "6fb8b0d7-c40e-4692-ad85-b5f2208c2f78",
"organizationId": "2497027d-1f9c-46e1-92cf-76f7b046305e"
}
200Success
{
"success": true,
"response": [
{
"advancedBalanceId": "b40d8a13-82b6-4d11-9b44-e09cf8a4c1b1",
"currency": "USD",
"blocked": true,
"blockReason": null,
"balance": "12",
"availableCurrenciesForDeposit": [
"USDT"
]
}
]
}
Last updated