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
ed83d19f-30ef-4b3f-bca9-edd2c7714b16
organizationIdstringOptionalExample:
ID of the created organization
a61799b2-cd0c-47fd-a7f0-216b2be184c7
Responses
200Success
application/json
post
POST /partner/api/get-organization-advanced-balances HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"userId": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
"organizationId": "a61799b2-cd0c-47fd-a7f0-216b2be184c7"
}
200Success
{
"success": true,
"response": [
{
"advancedBalanceId": "02b79edc-b5fb-456f-98f8-0a44d913d666",
"currency": "USD",
"blocked": true,
"blockReason": null,
"balance": "12",
"availableCurrenciesForDeposit": [
"USDT"
]
}
]
}
Last updated