Documentação para Desenvolvedores

Transações

Recurso Descrição
GET /api/v1/transactions/:id Informações da transação
GET /api/v1/transactions Listar transações

Modelo de Dados

Parâmetro Obr. Tipo Tamanho Descrição
id N/A Integer   ID da transação
amount N/A Float   Quantia (R$)
description N/A Text   Descrição na transação.
kind N/A String 255 Tipo da transação.
status N/A String 20 Status da transação.
processed_at N/A Date   Data do processamento.
sent_at N/A Date   Data da transferência para os casos de saque (kind: withdrawal).
credit_at N/A Date   Data de quando a transação entra para o saldo.

Dicionário de Dados

kind

fee Taxa
credit Crédito
withdrawal Saque
withdrawal_fee Taxa Saque
chargeback Estorno
chargeback_fee Taxa Estorno
addon_fee Addon

status

unprocessed Aguardando  
processed Processado  
transferred Transferido Somente para os casos de saque (kind: withdrawal)

Informações da transação

GET /api/v1/transactions/:id

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET 'https://sandbox.boletosimples.com.br/api/v1/transactions/1'
Resposta:
HTTP/1.1 200 OK
Date: Fri, 17 Oct 2014 19:46:16 GMT
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "amount":-0.4,
  "created_at":"2014-10-31",
  "description":"Saque manual",
  "kind":"withdrawal",
  "processed_at":"2014-10-31",
  "sent_at":null,
  "status":"processed",
  "credit_at":"2014-10-31"
}

Listar transações

GET /api/v1/transactions

Parâmetro Obr. Tipo Descrição
page Não Number Número da Página
per_page Não Number Quantidade de registros por página

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET "https://sandbox.boletosimples.com.br/api/v1/transactions?page=1&per_page=2"
Resposta:
HTTP/1.1 200 OK
Date: Fri, 17 Oct 2014 19:46:16 GMT
Status: 200 OK
Link: <https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2>; rel="last", <https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2>; rel="next"
Total: 4
Content-Type: application/json; charset=utf-8
...

[
  {
    "id": 59,
    "amount": 9.01,
    "created_at": "2015-02-10",
    "description": "Boleto Banc\u00e1rio 688",
    "kind": "credit",
    "processed_at": "2015-02-19",
    "sent_at": null,
    "status": "processed",
    "credit_at": "2015-02-19"
  },
  {
    "id": 60,
    "amount": -5,
    "created_at": "2015-02-10",
    "description": "Boleto Banc\u00e1rio 688",
    "kind": "fee",
    "processed_at": "2015-02-19",
    "sent_at": null,
    "status": "processed",
    "credit_at": "2015-02-19"
  }
]
Requisição:
@transactions = BoletoSimples::Transaction.all(page: 1, per_page: 2)
puts "Transações Retornadas: #{@transactions.count}"
puts "Total: #{BoletoSimples.last_request.total}"
puts "Primeira Página: #{BoletoSimples.last_request.links[:first]}"
puts "Página Anterior: #{BoletoSimples.last_request.links[:prev]}"
puts "Próxima Página: #{BoletoSimples.last_request.links[:next]}"
puts "Última Página: #{BoletoSimples.last_request.links[:last]}"
Resposta:
Transações Retornadas: 2
Total: 4
Primeira Página:
Página Anterior:
Próxima Página: https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2
Última Página: https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2
Requisição:
$transactions = BoletoSimples\Transaction::all(['page' => 1, 'per_page' => 2]);
echo "Transações Retornadas: " . sizeof($transactions) . "\n";
echo "Total: " . BoletoSimples::$last_request->total . "\n";
echo "Primeira Página: " . BoletoSimples::$last_request->links['first'] . "\n";
echo "Página Anterior: " . BoletoSimples::$last_request->links['prev'] . "\n";
echo "Próxima Página: " . BoletoSimples::$last_request->links['next'] . "\n";
echo "Última Página: " . BoletoSimples::$last_request->links['last'] . "\n";
Resposta:
Transações Retornadas: 2
Total: 4
Primeira Página:
Página Anterior:
Próxima Página: https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2
Última Página: https://sandbox.boletosimples.com.br/api/v1/transactions?page=2&per_page=2