Search by id

The method allows you to find an address belonging to an organization by its ID, regardless of its type

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 id

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

application/json

idstringRequired

ID of the address in the system

Example: ade16b1c-8d41-484a-8c63-677740b39e46

Responses

200Success

application/json

Successful response

successbooleanRequired

Request success indicator

responseany ofRequired

or

nullOptional

post

/api-gateway/addresses/find-by-id

HTTPcURLJavaScriptPython

POST /api-gateway/addresses/find-by-id HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "ade16b1c-8d41-484a-8c63-677740b39e46"
}

200Success

{
  "success": true,
  "response": {
    "id": "ade16b1c-8d41-484a-8c63-677740b39e46",
    "type": "PAY_IN",
    "alias": "Some address",
    "comment": null,
    "currency": "USDT",
    "network": "ethereum",
    "balance": "2956.1243",
    "address": "0x788529118F2A28C60b9de2Ba0353f5EE4293e044",
    "tag": null,
    "meta": null,
    "isArchived": true
  }
}