Search by address

The method allows you to find addresses belonging to an organization at an address in the blockchain, regardless of the type and network. Returns an array of addresses found

Description of fields

Field
Type
Description

id

string

ID of the address in the system

type

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

Address type

alias

string or null

The name of the address. It is set by the merchant

comment

string or null

Address comment. It is set by the merchant

currency

string

Address coin

network

string

Address network

balance

string

Address balance

address

string

Address in the blockchain

tag

string or null

The tag (MEMO) of the address. Available for networks that support the tag, for example Ripple

meta

any

Meta data. The free field is set by the merchant

isArchived

boolean

The address is in the archive

Search by address

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
addressstringRequired

Address in the blockchain

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