Pix - Documentação

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

Consultar lista de cobranças imediatas.

Sem ações implementadas definidas

Request

Query params
inicio Required Type: string Ex: 2023-07-03T00:35:00Z fim Required Type: string Ex: 2023-08-29T23:22:31Z cpf Type: string Ex: 24649507006 cnpj Type: string Ex: 89321417000160 status Type: string [ ATIVA, CONCLUIDA, REMOVIDO_PELO_USUARIO_RECEBEDOR, REMOVIDO_PELO_PSP ] Ex: ATIVA paginacao.paginaAtual Type: integer Valor padrão: 0 Ex: 3 paginacao.itensPorPagina Type: integer Valor padrão: 100 Ex: 10

Query params

inicio

Required

Type: string

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

fim

Required

Type: string

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

cpf

Type: string

Ex: 24649507006

cnpj

Type: string

Ex: 89321417000160

status

Type: string

[ ATIVA, CONCLUIDA, REMOVIDO_PELO_USUARIO_RECEBEDOR, REMOVIDO_PELO_PSP ]

Ex: ATIVA

paginacao.paginaAtual

Type: integer

Valor padrão: 0

Ex: 3

paginacao.itensPorPagina

Type: integer

Valor padrão: 100

Ex: 10

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

Lista de cobranças imediatas.

parametros

Object

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

inicio

String

Data inicial utilizada na consulta. Respeita RFC 3339.

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

fim

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

Object

paginaAtual

Integer >= 0

Número da página recuperada.

itensPorPagina

Integer >= 1

Quantidade de registros retornado na página.

Ex: 100

quantidadeDePaginas

Integer >= 1

Quantidade de páginas disponíveis para consulta.

Ex: 5

quantidadeTotalDeItens

Integer >= 0

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

Ex: 503

cobs Array

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "parametros": {
    "inicio": "2023-08-01T03:00:00Z",
    "fim": "2023-08-01T3:00:00Z",
    "cpf": "<CPF>",
    "cnpj": "<CNPJ>",
    "status": "ATIVA",
    "paginacao": {
      "paginaAtual": "<PAGINAATUAL>",
      "itensPorPagina": 100,
      "quantidadeDePaginas": 5,
      "quantidadeTotalDeItens": 503
    },
    "cobs": [
      "<COBS>"
    ]
  }
}

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

Criar cobrança imediata

Sem ações implementadas definidas

Request

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Body

Content Type: 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

Example

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"
    }
  ]
}

Response

200
successful

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

Consultar cobrança imediata

Sem ações implementadas definidas

Request

Path variables
txid Required Type: string txid

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200
successful

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

Criar cobrança imediata

Sem ações implementadas definidas

Request

Path variables
txid Required Type: string txid

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Body

Content Type: 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

Example

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"
    }
  ]
}

Response

200
successful

post https://api.pix.iugu.com/ext/recipients

Registrar beneficiário

Sem ações implementadas definidas

Request

Headers
workspace_id Required Type: string Identificador do workspace Ex: 7CCZCmQtLdROI4ZDLWMiEj

Body

Content Type: application/json

document_number

String

Ex: 51138259055

document_type

String
Enum: `cpf`, `cnpj`

Ex: cpf

name

String <= 120 characters

Ex: Nome Exemplo

Example

1
2
3
4
5
{
  "document_number": "51138259055",
  "document_type": "cpf",
  "name": "Nome Exemplo"
}

Response

200
successful

get https://api.pix.iugu.com/ext/recipients

Listar beneficiários

Sem ações implementadas definidas

Request

Headers
workspace_id Required Type: string Identificador do workspace Ex: 7CCZCmQtLdROI4ZDLWMiEj

Response

200
successful

This page