API de Transações
Obter Uma Transação
Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.
Estrutura
Para obter uma transação é utilizada a estrutura, conforme Tabela 01:
Método |
GET |
---|---|
URL |
https://api.asteroidetecnologia.com.br
|
Recurso |
/transactions/GUID_TRANSACAO |
Endpoint |
https://api.asteroidetecnologia.com.br/transactions/GUID_TRANSACAO
|
Exemplos
Para obter uma transação é preciso passar o GUID da transação. Por exemplo.: venda.5c3f7cfc652011.12070952
Veja alguns exemplos de como realizar uma requisição à API de Transações para obter uma transação.
# certifique-se de ter o comando "curl" instalado \ curl -X GET https://api.asteroidetecnologia.com.br/transactions/GUID_TRANSACAO_AQUI \ -H 'Content-Type: application/json' \ -H 'asteroide-key: SEU_TOKEN_AQUI' \ -H 'asteroide-pass: SUA_SENHA_AQUI'
// certifique-se de ter a extensão php_curl instalada $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.asteroidetecnologia.com.br/transactions/GUID_TRANSACAO_AQUI', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'asteroide-key: SEU_TOKEN_ASTEROIDE', 'asteroide-pass: SUA_SENHA_ASTEROIDE', ), CURLOPT_POSTFIELDS => '', )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo 'cURL Error #:' . $err; } else { echo $response; }
// No mesmo diretório do arquivo "package.json" // npm install --save request var request = require("request"); var options = { method: 'GET', url: 'https://api.asteroidetecnologia.com.br/transactions/GUID_TRANSACAO_AQUI', headers: { 'Content-Type': 'application/json', 'asteroide-key': 'SEU_TOKEN_ASTEROIDE', 'asteroide-pass': 'SUA_SENHA_ASTEROIDE' }, body : {} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Retorno JSON - Sucesso
Alguns campos podem variar dependendo do tipo da transação.
No caso de sucesso você deverá ver algo como no JSON a seguir.
{ "http_status": 200, "body": { "venda": { "id": "venda.5c3f7cfc652011.12070952", "identificador": "99999", "seu_id": "99999", "valor_total": "100.00", "qtd_parcelas": 1, "metadado": "", "tipo": "Cartão de Crédito", "status": "Aprovado", "codigo_pagamento": "10119011611382200113", "data_vencimento": null, "url_boleto": null, "numero_boleto": null, "linha_digitavel": null, "dias_vencimento": 2, "data_pagto_boleto": "2019-01-16 16:50:41", "data_baixa_boleto": null, "data_pagto": "2019-01-16 00:00:00", "valor_documento": "100.00", "data_desconto": null, "valor_desconto": null, "mensagem_desconto": null, "tid": "10119011611382200113", "proof_of_sale": "592510610", "codigo_autorizacao": "272320", "provider": "UseRede", "adquirente": "REDE", "mensagem_adquirente": "", "data_transacao_rede": "2019-01-16", "hora_transacao_rede": "16:50:38", "created_at": "2019-01-16 16:50:36", "updated_at": "2019-01-16 16:50:41", "data_estorno": null, "mensagem_estorno": null, "origem_venda": "API", "oneclick": "Não", "notificacao": null, "cartao": { "nome": "JOHN DOE", "expiracao": "10/2022", "bandeira": "MASTERCARD", "numero": "544828***0007", "hash": "cartao.5c3f7cfc663a98.18407031" }, "pix": { "location": "qrcodepix-h.bb.com.br/pix/v2/a8d5b1a5-c314-43a3-bcf2-2272aed10bea", "mensagem": "Cobrança ASTEROIDE", "qrcode": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/a8d5b1a5-c314-43a3-bcf2-2272aed10bea5204000053039865406100.005802BR5920ALAN GUIACHERO BUENO6008BRASILIA62070503***63045FF9", "chave": "testqrcode01@bb.com.br", "url": "https://api.asteroidetecnologia.com.br/p/venda.6054df60184b69.06644153" }, "comprador": { "id": "comprador.5c3e1f4bd88a73.48220694", "nome": "John Doe", "tipo_documento": "CPF", "documento": "01234567899", "email": "johndoe@gmail.com", "ddd": "11", "telefone": "987654321", "logradouro": "Av. Paulista", "numero": "1", "complemento": "CJ 222", "bairro": "Bela Vista", "cidade": "São Paulo", "estado": "SP", "cep": "01234567", "metadado": "" }, "parcelas": [ { "data_pagamento": "2019-02-17", "parcela": 1, "valor_bruto": "100.00", "custos": "2.49", "valor_liquido": "97.51", "taxa_venda": "0.19", "percentual_venda": "2.300", "status_repasse": "L" } ], "ocorrencias": [ { "data": "2019-01-16", "descricao": "Venda criada", "valor": "100.00" } ], "empresa": { "id": "SEU_TOKEN_ASTEROIDE", "nome": "ASTEROIDE TECNOLOGIA E PAGAMENTOS" } } } }
Retorno JSON - Erros
Caso o GUID_TRANSACAO usado não retorne uma transação, o retorno será:
{ "http_status": 404, "body": { "mensagem": "Não encontrada." } }