API de Transações
Criar Transação Oneclick
Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.
Estrutura
Para criar uma transação de oneclick é utilizada a estrutura, conforme Tabela 01:
Método |
POST |
---|---|
URL |
https://api.asteroidetecnologia.com.br
|
Recurso |
/transactions/oneclick |
Endpoint |
https://api.asteroidetecnologia.com.br/transactions/oneclick
|
Request Body - JSON
Para criar uma transação oneclick é preciso enviar o Request Body JSON, conforme exemplo:
(em seguida veja o que cada parâmetro significa).
{ "venda_id":"ABC123", "valor_total":"150.50", "token_cartao": "cartao.5c3f7cfc663a98.18407031", "cvv":"123", "qtd_parcelas": "3", "clear_sale_session_id": "7fc8ef54a8154c28341bf9a47443a5ce", "products": { "code": "123456789", "name": "Nome do Produto", "value": "100.00", "amount": "1" } }
Parâmetros
Parâmetro | Padrão | Descrição |
---|---|---|
token_cartao:String |
not null | O valor retornado em token_cartao no JSON de retorno ao criar uma transação de cartão. |
cvv:String |
not null | O código de verificação do cartão |
qtd_parcelas:Integer |
1 | A quantidade de parcelas (1 até 12) da transação |
venda_id:String |
not null | Um código interno de sua aplicação que você precisa associar à transação |
valor_total:Float |
not null | O valor da transação |
clear_sale_session_id:String |
null | Identificador do website para tratamento no sistema antifraude |
products.code:String |
null | Código do produto |
products.name:String |
null | Nome do produto |
products.value:Float |
null | Valor unitário |
products.amount:Integer |
null | Quantidade |
Exemplos
Veja alguns exemplos de como realizar uma requisição à API de Transações enviando o Request Body JSON para criar uma transação oneclick.
# certifique-se de ter o comando "curl" instalado \ curl -X POST https://api.asteroidetecnologia.com.br/transactions/oneclick \ -H 'Content-Type: application/json' \ -H 'asteroide-key: SEU_TOKEN_AQUI' \ -H 'asteroide-pass: SUA_SENHA_AQUI' \ -d '{ "venda_id":"ABC123", "valor_total":"150.50", "token_cartao": "cartao.5c3f7cfc663a98.18407031", "cvv":"123", "qtd_parcelas": "3", "clear_sale_session_id": "7fc8ef54a8154c28341bf9a47443a5ce", "products": { "code": "123456789", "name": "Nome do Produto", "value": "100.00", "amount": "1" } }'
// 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/oneclick', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'asteroide-key: SEU_TOKEN_ASTEROIDE', 'asteroide-pass: SUA_SENHA_ASTEROIDE', ), CURLOPT_POSTFIELDS => json_encode(array( 'venda_id' => 'ABC123', 'valor_total' => '150.50', 'token_cartao' => 'cartao.5c3f7cfc663a98.18407031', 'cvv' => '123', 'qtd_parcelas' => '3', 'clear_sale_session_id' => '7fc8ef54a8154c28341bf9a47443a5ce', 'products' => array( 'code' => '123456789', 'name' => 'Nome do Produto', 'value' => '100.00', 'amount' => '1' ) )), )); $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: 'POST', url: 'https://api.asteroidetecnologia.com.br/transactions/oneclick', headers: { 'Content-Type': 'application/json', 'asteroide-key': 'SEU_TOKEN_ASTEROIDE', 'asteroide-pass': 'SUA_SENHA_ASTEROIDE' }, json: true body : { 'venda_id': 'ABC123', 'valor_total': '150.50', 'token_cartao': 'cartao.5c3f7cfc663a98.18407031', 'cvv': '123', 'qtd_parcelas': '3', 'clear_sale_session_id': '7fc8ef54a8154c28341bf9a47443a5ce', 'products': { 'code': '123456789', 'name': 'Nome do Produto', 'value': '100.00', 'amount': '1' } } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Retorno JSON
No caso de sucesso você deverá ver algo como:
{ "http_status": 201, "body": { "seu_id": "ABC123", "codigo_pagamento": "10119011611382200172", "qtd_parcelas": 1, "cartao": { "nome": "JOHN DOE", "numero": "544828***0007", "token": "cartao.5c3f7cfc663a98.18407031", "bandeira": "MASTERCARD" }, "tipo": "credit", "guid": "venda.5c3f9d4db89ca2.20185040", "tid": "10119011611382200172", "proof_of_sale": "44468500", "codigo_autorizacao": "552430", "provider": "UseRede" } }
Tabela códigos e mensagens de erros: produtos
Código | Mensagem |
---|---|
4001 |
Nome do produto não pode estar vazio |
4002 |
Nome do produto não pode ter mais de 150 caracteres |