Documentação para Desenvolvedores

Saques

Recurso Descrição
GET /api/v1/withdrawals/new Novo saque
POST /api/v1/withdrawals Solicitar saque
GET /api/v1/withdrawals/:id Informações do saque
GET /api/v1/withdrawals Listar saques

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)

Novo saque

GET /api/v1/withdrawals/new

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/withdrawals/new'
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":null,
  "balance":0.0,
  "withdrawal_rate":5.0,
  "available_to_withdrawal":-5.0,
  "credit_at":"2015-04-17",
  "name":"Joao da Silva",
  "cnpj_or_cpf":"860.196.915-19",
  "bank_account":{
    "bank_name":"BANCO DO BRASIL",
    "agency_number_with_digit":"4042-8",
    "account_number_with_digit":"8873-0"
  }
}

Solicitar saque

POST /api/v1/withdrawals

Exemplo de requisição inválida

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X POST 'https://sandbox.boletosimples.com.br/api/v1/withdrawals'
Resposta:
HTTP/1.1 422 Unprocessable Entity
Date: Fri, 17 Oct 2014 18:39:47 GMT
Status: 422 Unprocessable Entity
Content-Type: application/json; charset=utf-8
...

{"errors":{"amount":["não há saldo disponível"]}}

Exemplo de requisição válida

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X POST 'https://sandbox.boletosimples.com.br/api/v1/withdrawals'
Resposta:
HTTP/1.1 201 Created
Date: Fri, 17 Oct 2014 19:30:06 GMT
Status: 201 Created
Location: https://sandbox.boletosimples.com.br/api/v1/withdrawals/1
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"
}

Informações do saque

GET /api/v1/withdrawals/: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/withdrawals/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 saques

GET /api/v1/withdrawals

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/withdrawals?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/withdrawals?page=2&per_page=2>; rel="last", <https://sandbox.boletosimples.com.br/api/v1/withdrawals?page=2&per_page=2>; rel="next"
Total: 4
Content-Type: application/json; charset=utf-8
...

[
  {
    "id":1,
    "amount":-0.4,
    "created_at":"2014-10-30",
    "description":"Saque manual",
    "kind":"withdrawal",
    "processed_at":"2014-10-30",
    "sent_at":null,
    "status":"processed",
    "credit_at":"2014-10-30"
  },
  {
    "id":2,
    "amount":-10.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"
  }
]