API Pix Manager (1.0.0)
Download OpenAPI specification:Download
A API Pix Manager oferece recursos para:
- Cobranças (Charges): listagem, detalhes (incluindo pixRecebidos, devoluções), e filtros.
- Credenciais (Credentials): criação, atualização, listagem, exclusão.
Listar Cobranças
Retorna lista paginada de cobranças ativas, mostrando apenas colunas específicas
(id, txId, recNome, etc.).
Também retorna meta com dados de paginação (página atual, total, etc.).
Request Body schema: application/jsonrequired
| page required | integer Default: 1 |
| perPage required | integer Default: 25 |
| filter | string Busca parcial em |
| queryFilter | Array of objects Filtros avançados via |
| sortBy | string Campo para ordenação (ex: calCriacao). |
| sortOrder | string Default: "desc" Enum: "asc" "desc" |
Responses
Response Schema: application/json
Array of objects (ChargeListItem) Array de cobranças encontradas (campos selecionados). | |
object (PaginationMetadata) Metadados para controle de paginação. |
Request samples
- Payload
Content type
application/json
{- "page": 1,
- "perPage": 25,
- "filter": "string",
- "queryFilter": [
- { }
], - "sortBy": "string",
- "sortOrder": "asc"
}Response samples
- 200
Content type
application/json
{- "data": [
- {
- "id": "string",
- "txId": "string",
- "recNome": "string",
- "recNomeFantasia": "string",
- "devCpf": "string",
- "devCnpj": "string",
- "devNome": "string",
- "statusCobranca": "ATIVA",
- "tipoCobranca": "IMEDIATA",
- "valOriginal": "string",
- "calCriacao": "2019-08-24T14:15:22Z",
- "calDataDeVencimento": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 0,
- "perPage": 0,
- "currentPage": 0,
- "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "prevPage": 0
}
}Detalhar Cobrança
Retorna dados completos de uma cobrança específica.
path Parameters
| id required | string ID da cobrança |
Responses
Response Schema: application/json
| id | string |
| revisao | integer |
| recNome | string or null |
| recNomeFantasia | string or null |
| devNome | string or null |
| statusCobranca | string Enum: "ATIVA" "CONCLUIDA" "REMOVIDA_PELO_USUARIO_RECEBEDOR" "REMOVIDA_PELO_PSP" |
| tipoCobranca | string Enum: "IMEDIATA" "VENCIMENTO" |
| valOriginal | string Valor original em decimal string. |
| calCriacao | string <date-time> |
| calDataDeVencimento | string or null <date-time> |
object or null | |
| pixCopiaECola | string Conteúdo BR Code gerado dinamicamente. |
Array of objects Lista de WebhookTasks relacionadas via endToEndId. |
Response samples
- 200
Content type
application/json
{- "id": "string",
- "revisao": 0,
- "recNome": "string",
- "recNomeFantasia": "string",
- "devNome": "string",
- "statusCobranca": "ATIVA",
- "tipoCobranca": "IMEDIATA",
- "valOriginal": "string",
- "calCriacao": "2019-08-24T14:15:22Z",
- "calDataDeVencimento": "2019-08-24T14:15:22Z",
- "pixRecebidos": {
- "id": "string",
- "endToEndId": "string",
- "valor": "string",
- "nomePagador": "string",
- "devolucoes": [
- {
- "id": "string",
- "valor": "string",
- "status": "EM_PROCESSAMENTO"
}
]
}, - "pixCopiaECola": "string",
- "tarefas": [
- {
- "id": 0,
- "webhookId": 0,
- "url": "string",
- "status": "QUEUED",
- "pixId": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Detalhar Cobrança por TxId
Retorna a cobrança (IMEDIATA ou VENCIMENTO) identificada pelo txId.
path Parameters
| txId required | string TxId da cobrança |
Responses
Response Schema: application/json
One of
| revisao | integer |
| chave | string Chave Pix registrada no DICT. |
| txid | string Identificador único da transação (txId). |
| status | string Enum: "ATIVA" "CONCLUIDA" "REMOVIDA_PELO_USUARIO_RECEBEDOR" "REMOVIDA_PELO_PSP" |
| solicitacaoPagador | string or null Texto livre a ser exibido ao pagador. |
Array of objects Lista de informações adicionais que podem ser exibidas ao pagador. | |
object (CalendarioImediato) | |
object | |
object (Usuario) Conta/Agência do usuário recebedor ou devedor. |
Response samples
- 200
- 404
Content type
application/json
Example
{- "revisao": 0,
- "chave": "string",
- "txid": "string",
- "status": "ATIVA",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
], - "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "apresentacao": "2019-08-24T14:15:22Z",
- "expiracao": 0,
- "description": null
}, - "valor": {
- "original": "string",
- "modalidadeAlteracao": 0,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAgente": "string",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAgente": "string",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "usuario": {
- "accNumber": "string",
- "accBranch": "string"
}
}Criar Credencial
Cria uma credencial informando clientId, clientSecret e attributes.
Request Body schema: application/jsonrequired
| clientId required | string Identificador único para a credencial. |
| clientSecret | string or null |
required | object (CredentialAttributes) |
Responses
Response Schema: application/json
| id | string ID interno gerado para a credencial. |
| clientId | string |
| clientSecret | string or null |
object (CredentialAttributes) |
Request samples
- Payload
Content type
application/json
{- "clientId": "string",
- "clientSecret": "string",
- "attributes": {
- "addrDistrict": "string",
- "addrAddress": "string",
- "addrCity": "string",
- "addrState": "string",
- "addrZipCode": "string",
- "addrNumber": "string",
- "email": "string",
- "phone": "string",
- "personType": "NATURAL_PERSON",
- "personDocument": "string",
- "accountBranch": "string",
- "accountNumber": "string",
- "name": "string",
- "tradeName": "string",
- "rules": { }
}
}Response samples
- 200
Content type
application/json
{- "id": "string",
- "clientId": "string",
- "clientSecret": "string",
- "attributes": {
- "addrDistrict": "string",
- "addrAddress": "string",
- "addrCity": "string",
- "addrState": "string",
- "addrZipCode": "string",
- "addrNumber": "string",
- "email": "string",
- "phone": "string",
- "personType": "NATURAL_PERSON",
- "personDocument": "string",
- "accountBranch": "string",
- "accountNumber": "string",
- "name": "string",
- "tradeName": "string",
- "rules": { }
}
}Atualizar Credencial
Atualiza credencial usando clientId e dados parciais em attributes.
Request Body schema: application/jsonrequired
| clientId required | string non-empty Identificador único da credencial (obrigatório). |
object Objeto opcional que contém apenas os campos a serem modificados. |
Responses
Response Schema: application/json
| message | string |
Request samples
- Payload
Content type
application/json
{- "clientId": "string",
- "attributes": {
- "addrDistrict": "string",
- "addrAddress": "string",
- "addrCity": "string",
- "addrState": "string",
- "addrZipCode": "string",
- "addrNumber": "string",
- "phone": "string",
- "name": "string",
- "tradeName": "string"
}
}Response samples
- 200
Content type
application/json
{- "message": "Credencial atualizada."
}Obter Credencial
Retorna os dados de uma credencial específica pelo clientId.
path Parameters
| clientId required | string Identificador único da credencial |
Responses
Response Schema: application/json
| id | string |
| clientId | string |
| nome | string |
| nomeFantasia | string or null |
| documento | string |
string or null | |
| tipo | string Enum: "FISICA" "JURIDICA" |
| criacao | string <date-time> |
Response samples
- 200
Content type
application/json
{- "id": "string",
- "clientId": "string",
- "nome": "string",
- "nomeFantasia": "string",
- "documento": "string",
- "email": "string",
- "tipo": "FISICA",
- "criacao": "2019-08-24T14:15:22Z"
}Listar Credenciais
Retorna uma lista paginada de credenciais de acordo com filtros.
Request Body schema: application/jsonrequired
| page required | integer Default: 1 |
| perPage required | integer Default: 10 |
| filter | string Filtro simples no nome/documento etc. |
| queryFilter | Array of objects Filtros avançados via queryFilterCb. |
| sortBy | string Default: "criacao" |
| sortOrder | string Default: "desc" Enum: "asc" "desc" |
Responses
Response Schema: application/json
Array of objects (CredentialListItem) Lista de credenciais. | |
object (PaginationMetadata) Metadados para controle de paginação. |
Request samples
- Payload
Content type
application/json
{- "page": 1,
- "perPage": 10,
- "filter": "string",
- "queryFilter": [
- { }
], - "sortBy": "criacao",
- "sortOrder": "asc"
}Response samples
- 200
Content type
application/json
{- "data": [
- {
- "id": "string",
- "nome": "string",
- "nomeFantasia": "string",
- "documento": "string",
- "email": "string",
- "tipo": "FISICA",
- "criacao": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 0,
- "perPage": 0,
- "currentPage": 0,
- "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "prevPage": 0
}
}