Docs

Boleto iugu

get TBD/api/v1/recipients

Listagem de beneficiários

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Parâmetros no Cabeçalho

  • WORKSPACE_ID

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful
post TBD/api/v1/recipients

Registrar beneficiário

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Schema

Tipo de conteúdo: application/json
document_number
String

Ex: 51138259055
document_type
String

Ex: cpf
name
String

Ex: Nome Exemplo
trade_name
String

Ex: Nome Fantasia
person_type
String

Ex: natural
Exemplo 
1
2
3
4
5
6
7

{
  "document_number": "51138259055",
  "document_type": "cpf",
  "name": "Nome Exemplo",
  "trade_name": "Nome Fantasia",
  "person_type": "natural"
}

Parâmetros no Cabeçalho

  • WORKSPACE_ID

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful
get TBD/api/v1/recipients/{recipientId}

Consultar beneficiário

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Parâmetros de Path

  • recipientId

    Obrigatório

    Integer

    Identificador do beneficiário

Respostas
200
successful
id
Number

ID do beneficiário
document_number
String

RG do beneficiário
person_type
String

natural ou juridical
status
String

status do beneficiário (pending, able ou unable)
name
String

trade_name
String

external_id
String

workspace_id
String

put TBD/api/v1/recipients/{recipientId}

Atualiza beneficiário

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Schema

Tipo de conteúdo: application/json
name
String

Ex: Nome Exemplo
trade_name
String

Ex: Nome Fantasia
Exemplo 
1
2
3
4

{
  "name": "Nome Exemplo",
  "trade_name": "Nome Fantasia"
}

Parâmetros de Path

  • recipientId

    Obrigatório

    Integer

    Identificador do beneficiário

Respostas
200
successful
id
Number

ID do beneficiário
document_number
String

RG do beneficiário
person_type
String

natural ou juridical
status
String

status do beneficiário (pending, able ou unable)
name
String

trade_name
String

external_id
String

workspace_id
String

post TBD/api/v1/settlement_accounts

Cadastra a conta de liquidação

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Schema

Tipo de conteúdo: application/json
recipient_id
Integer

Ex: 2
document_number
String

Ex: 51138259055
document_type
String

Ex: cpf
ispb
Integer

Ex: 123456
branch
Integer

Ex: 3
account_number
Integer

Ex: 452562
account_type
String

Ex: checking
Exemplo 
1
2
3
4
5
6
7
8
9

{
  "recipient_id": 2,
  "document_number": "51138259055",
  "document_type": "cpf",
  "ispb": 123456,
  "branch": 3,
  "account_number": 452562,
  "account_type": "checking"
}

Respostas
200
successful
get TBD/api/v1/boletos/{boletoId}

Consultar boleto

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Parâmetros de Path

  • boletoId

    Obrigatório

    Integer

    Identificador do boleto

Respostas
200
successful
put TBD/api/v1/boletos/{boletoId}

Atualiza o boleto

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Schema

Tipo de conteúdo: application/json
name
String

Ex: Nome Exemplo
trade_name
String

Ex: Nome Fantasia
Exemplo 
1
2
3
4

{
  "name": "Nome Exemplo",
  "trade_name": "Nome Fantasia"
}

Parâmetros de Path

  • boletoId

    Obrigatório

    Integer

    Identificador do boleto

Respostas
200
successful
post TBD/api/v1/boletos

Cria o boleto

Autorizações
BearerAuth
HTTP Authorization Scheme: bearer

Schema

Tipo de conteúdo: application/json
document_info
Object

amount_cents
Integer

Ex: 80000
abatement
Integer

Ex: 10
expires_at
String

Ex: 10/10/2023
due_at
String

Ex: 02/10/2023
our_number
Integer

Ex: 123456
discounts
Object

date
String

Ex: 01/10/2023
value
Number

Ex: 30
fines
Object

date
String

Ex: 03/10/2023
value
Number

Ex: 10
interests
Object

date
String

Ex: 03/10/2023
value
Number

Ex: 15
recipient
Object

document_number
String

Ex: 13881681035
person_type
String

Ex: natural
name
String

Ex: Carolina
trade_name
String

Ex: Nome Fantasia LTDA
address
Object

street
String

Ex: Rua Palacete
number
Integer

Ex: 20
complement
String

Ex: Apartamento 42
zipcode
Integer

Ex: 1172490
city
String

Ex: São Paulo
state
String

Ex: SP
payer
Object

document_number
String

Ex: 59733299090
person_type
String

Ex: natural
name
String

Ex: Luana
trade_name
String

Ex: Nome Fantasia LTDA
address
Object

street
String

Ex: Rua Palacete
number
Integer

Ex: 20
complement
String

Ex: Apartamento 42
zipcode
Integer

Ex: 1172490
city
String

Ex: São Paulo
state
String

Ex: SP
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

{
  "document_info": {
    "amount_cents": 80000,
    "abatement": 10,
    "expires_at": "10/10/2023",
    "due_at": "02/10/2023",
    "our_number": 123456,
    "discounts": {
      "date": "01/10/2023",
      "value": 30
    },
    "fines": {
      "date": "03/10/2023",
      "value": 10
    },
    "interests": {
      "date": "03/10/2023",
      "value": 15
    }
  },
  "recipient": {
    "document_number": 13881681035,
    "person_type": "natural",
    "name": "Carolina",
    "trade_name": "Nome Fantasia LTDA",
    "address": {
      "street": "Rua Palacete",
      "number": 20,
      "complement": "Apartamento 42",
      "zipcode": 1172490,
      "city": "São Paulo",
      "state": "SP"
    }
  },
  "payer": {
    "document_number": 59733299090,
    "person_type": "natural",
    "name": "Luana",
    "trade_name": "Nome Fantasia LTDA",
    "address": {
      "street": "Rua Palacete",
      "number": 20,
      "complement": "Apartamento 42",
      "zipcode": 1172490,
      "city": "São Paulo",
      "state": "SP"
    }
  }
}

Parâmetros no Cabeçalho

  • WORKSPACE_ID

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful