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
Header parameters
x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json
Body

The body of the request for replenishment of the advance balance

userIdstringRequired

User ID

Example: ed83d19f-30ef-4b3f-bca9-edd2c7714b16
organizationIdstringRequired

Organization ID

Example: a61799b2-cd0c-47fd-a7f0-216b2be184c7
advancedBalanceIdstringRequired

ID of the advance balance

Example: 02b79edc-b5fb-456f-98f8-0a44d913d666
amountstringRequired

The amount for which the balance is replenished

Example: 4.87
Responses
200Success
application/json
post
POST /partner/api/top-up-advanced-balance HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "userId": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
  "organizationId": "a61799b2-cd0c-47fd-a7f0-216b2be184c7",
  "advancedBalanceId": "02b79edc-b5fb-456f-98f8-0a44d913d666",
  "amount": "4.87"
}
200Success
{
  "success": true,
  "response": {
    "advancedBalanceId": "02b79edc-b5fb-456f-98f8-0a44d913d666",
    "currency": "USD",
    "blocked": true,
    "blockReason": null,
    "balance": "12",
    "availableCurrenciesForDeposit": [
      "USDT"
    ]
  }
}

Last updated