Withdrawal API - aegonplatform/gateway-pub-sample GitHub Wiki

<< API de depósito | Resposta com Webhook >>

API de saque

Disponibiliza métodos para manipulação de dados referentes a saques.

Endpoint	Método	Descrição
/withdrawals/createwithdrawal	GET	Cria nova solicitação de saque
/withdrawals/gettransaction/{txid}	GET	Retorna dados de uma transação por ID
/withdrawals/gettransactionbyaddress/{address}	GET	Retorna dados de uma transação por endereço de depósito

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

Nova solicitação de saque

Cria nova solicitação de saque.

Resource URL
/withdrawals/createwithdrawal

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 solicitando o saque	Sim
address	string	Endereço do ticker da moeda que receberá o montante	Sim
amount	string	Valor na moeda (ex: BTC) solicitado	Sim
destTag	string	DestTag caso o destino possua e exija esta informação	Não
note	string	Anotações	Não
customer	json/string	Objeto JSON com os dados do cliente associados a esta transação	Não
referenceId	string	ID de referência da aplicação cliente	Não

Exemplo de envio

http://gateway-pub.mydomain.com/api/withdrawals/createwithdrawal?ticker=BTC&[email protected]&address=2NGZrVvZG92qGYqzTLjCAewvPZ7JE8S8VxE&amount=0.001&destTag=&note=&customer={"name":"Test","lang":"en", "thumbnail":"http://img.images.com/avatar.jpg","joker":{}}

Exemplo de resposta

{
  "amount": 0.001,
  "scheduling": 1576593706069,
  "created": 1576593706070
}

Modelo de dados / Resposta

Nome	Tipo	Descricao
amount	string	Valor da transação na blockchain (valor depositado de fato na blockchain)
scheduling	string	Timestamp agendado para pagamento pelo gateway
created	string	Timestamp da criação da transação no gateway

Retorna dados de uma transação por ID

Retorna dados de uma transação por ID.

Resource URL
/withdrawals/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/withdrawals/gettransaction/ee0e5bbb6f761f64c726cb891c28ffd5fbddf9a965c74dc671fd6ae2ed2b21b1

Exemplo de resposta

{
  "ticker": "btc",
  "type": "withdrawal",
  "status": "finished",
  "amount": 0.001,
  "address": "2NGZrVvZG92qGYqzTLjCAewvPZ7JE8S8VxE",
  "txid": "ba235cae02835d060555d2fb95fea7e5ae428ca095cabb1ea5e2cdf60397d452",
  "confirmations": 1,
  "fee": -0.00000368,
  "scheduling": 1576593706069,
  "created": 1576593706070,
  "finished": 1576595061245,
  "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: `scheduled (saque agendado para pagamento no gateway), rejected (saque rejeitado no gateway), no-funds (saque aguardando fundos para pagamento), blockchain (saque enviado para blockchain), finished (saque finalizado)`
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
approved	string	Indica se a transação foi aprovada manualmente dentro do gateway
auto	string	Indica se a transação foi aprovada automaticamente dentro do gateway
scheduling	string	Timestamp agendado para pagamento pelo gateway
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
/withdrawals/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/withdrawals/gettransactionbyaddress/mhQXSiDjNWue5AM58qrdbBC5ZUbNLi4tYb

Exemplo de resposta

{
  "ticker": "btc",
  "type": "withdrawal",
  "status": "finished",
  "amount": 0.001,
  "address": "2NGZrVvZG92qGYqzTLjCAewvPZ7JE8S8VxE",
  "txid": "ba235cae02835d060555d2fb95fea7e5ae428ca095cabb1ea5e2cdf60397d452",
  "confirmations": 1,
  "fee": -0.00000368,
  "scheduling": 1576593706069,
  "created": 1576593706070,
  "finished": 1576595061245,
  "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: `scheduled (saque agendado para pagamento no gateway), rejected (saque rejeitado no gateway), no-funds (saque aguardando fundos para pagamento), blockchain (saque enviado para blockchain), finished (saque finalizado)`
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.
approved	string	Indica se a transação foi aprovada manualmente dentro do gateway
auto	string	Indica se a transação foi aprovada automaticamente dentro do gateway
scheduling	string	Timestamp agendado para pagamento pelo gateway
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

<< Depósitos | Resposta com Webhook >>