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

Getting the user's advance balances

POSThttps://ocp.onchainpay.io/partner/api/get-organization-advanced-balances
Header parameters
Body
userId*string

User ID

Example: "b62ffd59-158b-4daf-aeb0-cc02c710f615"
organizationIdstring

ID of the created organization

Example: "6691face-ec14-4fd5-94a8-f6307dcb22a4"
Response
Body
success*boolean

Request success indicator

response*GetPartnerAdvancedBalancesResponse (array of PartnerAdvancedBalancesSource (object))

The body of the response for receiving the list of advance balances

Request
const response = await fetch('https://ocp.onchainpay.io/partner/api/get-organization-advanced-balances', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "b62ffd59-158b-4daf-aeb0-cc02c710f615"
    }),
});
const data = await response.json();
Response
{
  "success": false,
  "response": [
    {
      "advancedBalanceId": "bb837399-bb7a-4d97-9cab-4d47c1b198ba",
      "currency": "USD",
      "blocked": false,
      "blockReason": null,
      "balance": "12",
      "availableCurrenciesForDeposit": [
        "USDT"
      ]
    }
  ]
}

Last updated