Deposit api - aegonplatform/gateway-pub-sample GitHub Wiki

<< Web Service API | API de saque >>

API de depósito

Disponibiliza métodos para manipulação de dados referentes a depósitos.

Endpoint Método Descrição
/deposits/getnewaddress GET Solicita novo endereço
/deposits/gettransaction/{txid} GET Retorna dados de uma transação por ID
/deposits/gettransactionbyaddress/{address} GET Retorna dados de uma transação por endereço
/deposits/aegonpurchaseorder GET Solicita novo endereço de depósito para adquirir créditos AEGON (AEGON Cash)

Veja alguns classes para seu projeto e exemplos de código em sua linguagem de programação.

Novo endereço para depósito

Solicita novo endereço para depósito.

Resource URL
/deposits/getnewaddress

Available Version
Todas

HTTP Methods
GET

Parâmetros

Nome Tipo Descrição Mandatório
ticker string Ticker da Moeda, ex: BTC Sim
email string Email da pessoa que está solicitando endereço Sim
fromMaster string Buscar novo endereco da conta master do Gateway Nao
customer json/string Informações detalhadas do cliente Nao
referenceId string ID de referência da aplicação cliente Nao

Exemplo de envio

http://gateway-pub.mydomain.fun/api/deposits/getnewaddress?ticker=BTC&[email protected]&fromMaster=true&customer={"name":"Test","lang":"en", "thumbnail":"http://img.images.com/avatar.jpg","joker":{}}

Exemplo de resposta

{
  "address": "mmRsBDx4yUEj4qDMNY2qvMiQ344gXZtxf4",
  "destTag": "",
  "expired": 1576951456097
}

Modelo de dados / Resposta

Nome Tipo Descrição
address string Endereço do ticker solicitado
destTag string Flag para "Tag Destination", mercados futuros, retorno sempre vazio
expired string Timestamp de expiração do endereço

Retorna dados de uma transação por ID

Retorna dados de uma transação por ID.

Resource URL
/deposits/gettransaction/{txid}

Available Version
Todas

HTTP Methods
GET

Parâmetros

Nome Tipo Descrição Mandatório
txid string Id da transação Sim

Exemplo de envio

http://gateway-pub.mydomain.com/api/deposits/gettransaction/ee0e5bbb6f761f64c726cb891c28ffd5fbddf9a965c74dc671fd6ae2ed2b21b1

Exemplo de resposta

{
  "ticker": "btc",
  "type": "deposit",
  "status": "finished",
  "amount": 0.0001,
  "address": "mhQXSiDjNWue5AM58qrdbBC5ZUbNLi4tYb",
  "txid": "ee0e5bbb6f761f64c726cb891c28ffd5fbddf9a965c74dc671fd6ae2ed2b21b1",
  "confirmations": 1,
  "fee": 0,
  "created": 1576519822033,
  "finished": 1576520716660,
  "customer": {
    "email": "[email protected]",
    "name": "Test",
    "lang": "en",
    "thumbnail": "http://img.images.com/avatar.jpg",
    "joker": {}
  },
  "joker": {
    "referenceId": "1"
  }
}

Modelo de dados / Resposta

Nome Tipo Descricao
ticker string Ticker da Moeda, ex: BTC
type string Identifica o tipo de transação
status string Indica a situação atual do registro: **blockchain** (transação esta em blockchain e não confirmada ainda), **finished** (já confirmada e finalizada)
amount string Valor da transação na blockchain (valor depositado de fato na blockchain)
address string Endereço associado a esta transação
txid string ID da transação
confirmations string Quantidade de confirmações na blockchain desta transação
fee string Taxa da blockchain cobrada nesta transação
created string Timestamp da criação da transação no gateway
finished string Timestamp de quando a transação foi dada como finalizada no gateway
customer json/string Objeto JSON com os dados do cliente associados a esta transação
joker string Objeto JSON com dados extras como ID de referência da aplicação cliente

Retorna dados de uma transação por endereço (address)

Retorna dados de uma transação por endereço (address).

Resource URL
/deposits/gettransactionbyaddress/{address}

Available Version
Todas

HTTP Methods
GET

Parâmetros

Nome Tipo Descrição Mandatório
address string Endereço que gerou a transação Sim

Exemplo de envio

http://gateway-pub.mydomain.com/api/deposits/gettransactionbyaddress/mhQXSiDjNWue5AM58qrdbBC5ZUbNLi4tYb

Exemplo de resposta

{
  "ticker": "btc",
  "type": "deposit",
  "status": "finished",
  "amount": 0.0001,
  "address": "mhQXSiDjNWue5AM58qrdbBC5ZUbNLi4tYb",
  "txid": "ee0e5bbb6f761f64c726cb891c28ffd5fbddf9a965c74dc671fd6ae2ed2b21b1",
  "confirmations": 1,
  "fee": 0,
  "created": 1576519822033,
  "finished": 1576520716660,
  "customer": {
    "email": "[email protected]",
    "name": "Test",
    "lang": "en",
    "thumbnail": "http://img.images.com/avatar.jpg",
    "joker": {}
  },
  "joker": {
    "referenceId": "1"
  }
}

Modelo de dados / Resposta

Nome Tipo Descrição
ticker string Ticker da Moeda, ex: BTC
type string Identifica o tipo de transação
status string Indica a situação atual do registro: **blockchain** (transação esta em blockchain e não confirmada ainda), **finished** (já confirmada e finalizada)
amount string Valor da transação na blockchain (valor depositado de fato na blockchain)
address string Endereço associado a esta transação
txid string ID da transação
confirmations string Quantidade de confirmações na blockchain desta transação
fee string Taxa da blockchain cobrada nesta transação
created string Timestamp da criação da transação no gateway
finished string Timestamp de quando a transação foi dada como finalizada no gateway
customer json/string Objeto JSON com os dados do cliente associados a esta transação
joker string Objeto JSON com dados extras como ID de referência da aplicação cliente

Retorna dados para compra de créditos AEGON

Retorna dados para compra de créditos AEGON (AEGON Cash).

Resource URL
/deposits/aegonpurchaseorder

Available Version
Todas

HTTP Methods
GET

Parâmetros

Nome Tipo Descricao Mandatorio
ticker string Ticker em qual deseja pagar pelos créditos (use BTC) Sim
email string Email de quem esta solicitado os créditos Sim

Exemplo de envio

http://gateway-pub.mydomain.com/api/deposits/aegonpurchaseorder?ticker=btc&[email protected]

Exemplo de resposta

{
  "address": "moCPV6dB7Yw45t1TE3SDtjNMgiUSYaKun5",
  "destTag": "",
  "expired": 1577029061684,
  "fee": 0.01
}

Modelo de dados / Resposta

Nome Tipo Descrição
address string Endereço BTC (ou ticker) para efetuar o depósito
destTag string Flag para "Tag Destination", mercados futuros, retorno sempre vazio
expired string Timestamp de expiração do endereço
fee string Taxa negociada para utilização do gateway

<< Web Service API | API de saque >>

⚠️ **GitHub.com Fallback** ⚠️