Get Address

curl --request GET \
  --url https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId} \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "address": "0x7204855eA98E951a218A9CC69786D7Dc749d170A",
    "blockchain": {
      "createdAt": "2024-05-14T11:53:33.095Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "85ffc132-3972-4c9e-99a5-5cf0ccb688bf",
      "isActive": true,
      "isEvmCompatible": true,
      "logoUrl": "https://res.cloudinary.com/dkgdc1vnl/image/upload/v1771444998/crypto-assets/ethereum.png",
      "name": "ethereum",
      "slug": "ethereum",
      "symbol": "eth",
      "tokenStandard": "ERC20",
      "updatedAt": "2024-06-14T22:32:11.983Z"
    },
    "configurations": {
      "aml": {
        "message": "Address is not sanctioned",
        "provider": "ofac",
        "status": "success"
      },
      "disableAutoSweep": false,
      "enableGaslessWithdraw": false,
      "showPrivateKey": false
    },
    "createdAt": "2024-10-23T10:53:38.622Z",
    "derivationPath": "m/44'/60'/0'/0/86",
    "id": "259422b2-6c8f-40e0-822f-7d2d23c78323",
    "isActive": true,
    "metadata": null,
    "name": null,
    "network": "testnet",
    "type": "INTERNAL",
    "updatedAt": "2024-10-23T10:53:38.622Z"
  },
  "message": "Address fetched successfully",
  "statusCode": 200
}

Endereço

Get Address

This endpoint retrieves information about a specific address within a wallet.

Query Parameters

Name	Type	Required	Description
showPrivateKey	boolean	Optional	If `true`, the response will include the private key. If `false` or omitted, the private key is not computed.

GET

wallets

{walletId}

addresses

{addressId}

Get Address

curl --request GET \
  --url https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId} \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "address": "0x7204855eA98E951a218A9CC69786D7Dc749d170A",
    "blockchain": {
      "createdAt": "2024-05-14T11:53:33.095Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "85ffc132-3972-4c9e-99a5-5cf0ccb688bf",
      "isActive": true,
      "isEvmCompatible": true,
      "logoUrl": "https://res.cloudinary.com/dkgdc1vnl/image/upload/v1771444998/crypto-assets/ethereum.png",
      "name": "ethereum",
      "slug": "ethereum",
      "symbol": "eth",
      "tokenStandard": "ERC20",
      "updatedAt": "2024-06-14T22:32:11.983Z"
    },
    "configurations": {
      "aml": {
        "message": "Address is not sanctioned",
        "provider": "ofac",
        "status": "success"
      },
      "disableAutoSweep": false,
      "enableGaslessWithdraw": false,
      "showPrivateKey": false
    },
    "createdAt": "2024-10-23T10:53:38.622Z",
    "derivationPath": "m/44'/60'/0'/0/86",
    "id": "259422b2-6c8f-40e0-822f-7d2d23c78323",
    "isActive": true,
    "metadata": null,
    "name": null,
    "network": "testnet",
    "type": "INTERNAL",
    "updatedAt": "2024-10-23T10:53:38.622Z"
  },
  "message": "Address fetched successfully",
  "statusCode": 200
}

Autorizações

x-api-key

string

header

obrigatório

Parâmetros de caminho

walletId

string

obrigatório

Exemplo:

"YOUR_WALLET_ID"

addressId

string

obrigatório

Exemplo:

"ADDRESS_ID"

Parâmetros de consulta

showPrivateKey

string

Exemplo:

"OPTIONAL_BOOLEAN"

Resposta

200 - application/json

200 / Show Private Key

data

object

Show child attributes

message

string

Exemplo:

"Address fetched successfully"

statusCode

number

Exemplo:

200

Generate Address Update Address