Docs
Getting Started
API
...

Nesta página

get https://api.pix.iugu.com/api/v2/cob

Consultar lista de cobranças imediatas.

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Parâmetros de Query

  • inicio

    Obrigatório

    String

    Ex: 2023-07-03T00:35:00Z

  • fim

    Obrigatório

    String

    Ex: 2023-08-29T23:22:31Z

  • cpf
    String

    Ex: 24649507006

  • cnpj
    String

    Ex: 89321417000160

  • status
    String

    [ ATIVA, CONCLUIDA, REMOVIDO_PELO_USUARIO_RECEBEDOR, REMOVIDO_PELO_PSP ]

    Ex: ATIVA

  • paginacao.paginaAtual
    Integer

    Valor padrão: 0

    Ex: 3

  • paginacao.itensPorPagina
    Integer

    Valor padrão: 100

    Ex: 10

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
Lista de cobranças imediatas.
parametros

Obrigatório

Object

Parâmetros utilizados para a realização de uma consulta de cobranças.
inicio

Obrigatório

String

Data inicial utilizada na consulta. Respeita RFC 3339.

Ex: 2023-08-01T03:00:00Z
fim

Obrigatório

String

Data de fim utilizada na consulta. Respeita RFC 3339.

Ex: 2023-08-01T3:00:00Z
cpf
String ^\d{11}$

Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.
cnpj
String ^\d{14}$

Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.
status
String

Filtro pelo status das cobrançaas.

Ex: ATIVA
paginacao

Obrigatório

Object

paginaAtual

Obrigatório

Integer >= 0

Número da página recuperada.
itensPorPagina

Obrigatório

Integer >= 1

Quantidade de registros retornado na página.

Ex: 100
quantidadeDePaginas

Obrigatório

Integer >= 1

Quantidade de páginas disponí­veis para consulta.

Ex: 5
quantidadeTotalDeItens

Obrigatório

Integer >= 0

Quantidade total de itens disponí­veis de acordo com os paâmetros informados.

Ex: 503
cobs
Array

post https://api.pix.iugu.com/api/v2/cob

Criar cobrança imediata

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema

Tipo de conteúdo: application/json
calendario
Object

expiracao
Integer

Ex: 86400
devedor
Object

cpf
String
Enum: `cpf`, `cnpj`

Ex: 13881681035
nome
String

Ex: Testador Pix
valor
Object

original
String

Ex: 15.45
chave
String

Ex: 98862c23-28f8-4038-a8c8-c0bc9897bb60
solicitacaoPagador
String

Ex: Solicitação ao pagador
infoAdicionais
Array of objects

nome
String

Ex: Info Adicional
valor
String

Ex: Info Adicional
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "calendario": {
    "expiracao": 86400
  },
  "devedor": {
    "cpf": "13881681035",
    "nome": "Testador Pix"
  },
  "valor": {
    "original": "15.45"
  },
  "chave": "98862c23-28f8-4038-a8c8-c0bc9897bb60",
  "solicitacaoPagador": "Solicitação ao pagador",
  "infoAdicionais": [
    {
      "nome": "Info Adicional",
      "valor": "Info Adicional"
    }
  ]
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful
get https://api.pix.iugu.com/api/v2/cob/{txid}

Consultar cobrança imediata

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Parâmetros de Path

  • txid

    Obrigatório

    String

    txid

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful
put https://api.pix.iugu.com/api/v2/cob/{txid}

Criar cobrança imediata

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema

Tipo de conteúdo: application/json
calendario
Object

expiracao
Integer

Ex: 86400
devedor
Object

cpf
String
Enum: `cpf`, `cnpj`

Ex: 13881681035
nome
String

Ex: Testador Pix
valor
Object

original
String

Ex: 15.45
chave
String

Ex: 98862c23-28f8-4038-a8c8-c0bc9897bb60
solicitacaoPagador
String

Ex: Solicitação ao pagador
infoAdicionais
Array of objects

nome
String

Ex: Info Adicional
valor
String

Ex: Info Adicional
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "calendario": {
    "expiracao": 86400
  },
  "devedor": {
    "cpf": "13881681035",
    "nome": "Testador Pix"
  },
  "valor": {
    "original": "15.45"
  },
  "chave": "98862c23-28f8-4038-a8c8-c0bc9897bb60",
  "solicitacaoPagador": "Solicitação ao pagador",
  "infoAdicionais": [
    {
      "nome": "Info Adicional",
      "valor": "Info Adicional"
    }
  ]
}

Parâmetros de Path

  • txid

    Obrigatório

    String

    txid

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
successful
post https://api.pix.iugu.com/ext/recipients

Registrar beneficiário

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema

Tipo de conteúdo: application/json
document_number
String

Ex: 51138259055
document_type
String
Enum: `cpf`, `cnpj`

Ex: cpf
name
String <= 120 characters

Ex: Nome Exemplo
Exemplo 
1
2
3
4
5

{
  "document_number": "51138259055",
  "document_type": "cpf",
  "name": "Nome Exemplo"
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 7CCZCmQtLdROI4ZDLWMiEj

Respostas
200
successful
get https://api.pix.iugu.com/ext/recipients

Listar beneficiários

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 7CCZCmQtLdROI4ZDLWMiEj

Respostas
200
successful