Поиск по адресу

Метод позволяет найти адреса принадлежащие организации по адресу в блокчейне, вне зависимости от типа и сети. Возвращает найденных массив адресов

Описание полей

Поле
Тип
Описание

id

string

Идентификатор адреса в системе

type

enum(PAY_IN, BUSINESS, PAY_OUT, PERSONAL, RECURRENT)

Тип адреса

alias

string or null

Имя адреса. Устанавливается мерчантов

comment

string or null

Комментарий адреса. Устанавливается мерчантом

currency

string

Монета адреса

network

string

Сеть адреса

balance

string

Баланс адреса

address

string

Адрес в блокчейне

tag

string or null

Тег (MEMO) адреса. Доступно для сетей поддерживающих тег, например Ripple

meta

any

Мета данные. Свободное поле, устанавливается мерчантом

isArchived

boolean

Адрес находится в архиве

Поиск по адресу

post
Header parameters
x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json
Body
addressstringRequired

Адрес в блокчейне

Example: 0x788529118F2A28C60b9de2Ba0353f5EE4293e044
Responses
200Success
application/json
post
POST /api-gateway/addresses/find-by-address HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "address": "0x788529118F2A28C60b9de2Ba0353f5EE4293e044"
}
200Success
{
  "success": true,
  "response": [
    {
      "id": "dd2bfee3-1dfa-4b0c-bb9c-eeebe1321bec",
      "type": "PAY_IN",
      "alias": "Some address",
      "comment": null,
      "currency": "USDT",
      "network": "ethereum",
      "balance": "2956.1243",
      "address": "0x788529118F2A28C60b9de2Ba0353f5EE4293e044",
      "tag": null,
      "meta": null,
      "isArchived": true
    }
  ]
}

Last updated