Pular para o conteúdo principal
API docs by Redocly

CloudPix API

Download OpenAPI specification:Download

Neste documento estão disponíveis todas as informações relativas à interface de comunicação necessárias para efetuar transações e consultas ICOM, além de comunicação com o DICT no ambiente de gestão da ONZ PIX.
O endpoint deverá ser solicitado via e-mail suporte@onz.software informando o IP que será utilizado para ter acesso a API.
Para acessar a API é necessário estar com o Certificado Instalado (PFX) que será fornecido juntamente com o EndPoint.

Importante: Informamos que todos os requests com excessão do login, necessitam conter o parâmetro ONZ-Token no header, caso contrário a API retornará o Status 401 - Unauthorized.

ICOM

Requests para interação com a Interface de Comunicação (ICOM)

Long Polling

Serviço de long polling para consulta de mensagens recebidas.
O primeiro pullNext deve ser obriatóriamente start.
As consultas subsequentes devem usar o token recebido no header ONZ-Pull-Next da resposta anterior.

path Parameters
pullNext
required
string

Token de continuação do long polling (usar "start" na primeira chamada)

Responses

Response Headers
ONZ-Pull-Next
string

Token para a próxima consulta via long polling

Envio de PACS.002

Resposta para as mensagens PACS.008 e PACS.004

Request Body schema: application/json
required
idInstrucaoOriginal
required
string
idFimAFimOriginal
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...
situacaoDaTransacao
required
string
Enum: "ACSP" "RJCT"
codigoDeErro
string
Enum: "AB09" "AB03" "AC03" "AC06" "AC07" "AC14" "AG03" "AM02" "AM09" "BE01" "BE17" "CH11" "DS04" "DS24" "DT05" "RR04" "SL02" ""

Responses

Request samples

Content type
application/json
{
  • "idInstrucaoOriginal": "string",
  • "idFimAFimOriginal": "string",
  • "situacaoDaTransacao": "ACSP",
  • "codigoDeErro": "AB09"
}

Envio de PACS.004

Devolução de valores

Request Body schema: application/json
required
endToEndID
string
idFimAFim
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...
valor
required
number > 0
codigoDevolucao
required
string
motivoDevolucao
string
Default: ""
participanteUsuarioPagador
required
string
participanteUsuarioRecebedor
required
string

Responses

Request samples

Content type
application/json
{
  • "endToEndID": "string",
  • "idFimAFim": "string",
  • "valor": 0,
  • "codigoDevolucao": "string",
  • "motivoDevolucao": "",
  • "participanteUsuarioPagador": "string",
  • "participanteUsuarioRecebedor": "string"
}

Envio de PACS.008

Transferência de valores

Request Body schema: application/json
required
idConciliacaoRecebedor
string or null^\w+$|^$
valor
required
number > 0
nomeUsuarioPagador
required
string
cpfCnpjUsuarioPagador
string
contaUsuarioPagador
required
string <= 20 characters ^\d+$
agenciaUsuarioPagador
required
string <= 4 characters ^\d+$
tipoContaUsuarioPagador
required
string
Enum: "CACC" "SLRY" "SVGS" "TRAN"
participanteDoUsuarioPagador
required
string = 8 characters
participanteDoUsuarioRecebedor
required
string = 8 characters
cpfCnpjUsuarioRecebedor
required
string (cpfCnpj) ^[0-9]{11,14}$
contaUsuarioRecebedor
required
string <= 20 characters ^\d+$
agenciaUsuarioRecebedor
required
string <= 4 characters ^\d+$
tipoContaUsuarioRecebedor
required
string
Enum: "CACC" "SLRY" "SVGS" "TRAN"
informacoesEntreUsuarios
string
Default: ""
idContaTransacional
string
formaDeIniciacao
required
string
Enum: "MANU" "DICT" "INIC" "QRDN" "QRES" "QRPG"
finalidadeDaTransacao
required
string
Enum: "IPAY" "GSCB" "OTHR"
modalidadeAgente
string
Enum: "AGFSS" "AGTEC" "AGTOT"
prestadorDoServicoDeSaque
string
Array of objects
tipoPrioridadePagamento
string
Default: "PAGPRI"
Enum: "PAGPRI" "PAGFRD" "PAGAGD"
endToEndID
string (cpfCnpj) ^[0-9]{11,14}$
cnpjIniciadorPagamento
string (cpfCnpj) ^[0-9]{11,14}$
recebimento
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "idConciliacaoRecebedor": "string",
  • "valor": 0,
  • "nomeUsuarioPagador": "string",
  • "cpfCnpjUsuarioPagador": "string",
  • "contaUsuarioPagador": "string",
  • "agenciaUsuarioPagador": "stri",
  • "tipoContaUsuarioPagador": "CACC",
  • "participanteDoUsuarioPagador": "stringst",
  • "participanteDoUsuarioRecebedor": "stringst",
  • "cpfCnpjUsuarioRecebedor": "string",
  • "contaUsuarioRecebedor": "string",
  • "agenciaUsuarioRecebedor": "stri",
  • "tipoContaUsuarioRecebedor": "CACC",
  • "informacoesEntreUsuarios": "",
  • "idContaTransacional": "string",
  • "formaDeIniciacao": "MANU",
  • "finalidadeDaTransacao": "IPAY",
  • "modalidadeAgente": "AGFSS",
  • "prestadorDoServicoDeSaque": "string",
  • "informacoesValor": [
    ],
  • "tipoPrioridadePagamento": "PAGPRI",
  • "endToEndID": "string",
  • "cnpjIniciadorPagamento": "string",
  • "recebimento": "2019-08-24T14:15:22Z"
}

Envio de PAIN.009

Dados da recorrência

Request Body schema: application/json
required
tipoRecorrencia
required
string
Value: "RCUR"
tipoFrequencia
required
string
Enum: "MIAN" "MNTH" "QURT" "WEEK" "YEAR"
dataInicialRecorrencia
required
string <date>
idRecorrencia
required
string <= 29 characters
idSolicitacaoRecorrencia
required
string <= 29 characters
dataFinalRecorrencia
string or null <date>
indicadorObrigatorio
boolean
Default: false
valor
number > 0
indicadorPisoValorMaximo
boolean
Default: false
pisoValorMaximo
number or null > 0
nomeUsuarioRecebedor
required
string <= 140 characters
cpfCnpjUsuarioRecebedor
required
string (cpfCnpj) ^[0-9]{11,14}$
participanteDoUsuarioRecebedor
required
string = 8 characters
cpfCnpjUsuarioPagador
required
string (cpfCnpj) ^[0-9]{11,14}$
contaUsuarioPagador
required
string <= 20 characters
agenciaUsuarioPagador
string or null = 4 characters
participanteDoUsuarioPagador
required
string = 8 characters
object or null
numeroContrato
required
string <= 35 characters
descricao
string or null <= 35 characters
permiteNovaTentativa
boolean
Default: false
solicExpiracao
required
string

Responses

Request samples

Content type
application/json
{
  • "tipoRecorrencia": "RCUR",
  • "tipoFrequencia": "MIAN",
  • "dataInicialRecorrencia": "2019-08-24",
  • "idRecorrencia": "string",
  • "idSolicitacaoRecorrencia": "string",
  • "dataFinalRecorrencia": "2019-08-24",
  • "indicadorObrigatorio": false,
  • "valor": 0,
  • "indicadorPisoValorMaximo": false,
  • "pisoValorMaximo": 0,
  • "nomeUsuarioRecebedor": "string",
  • "cpfCnpjUsuarioRecebedor": "string",
  • "participanteDoUsuarioRecebedor": "stringst",
  • "cpfCnpjUsuarioPagador": "string",
  • "contaUsuarioPagador": "string",
  • "agenciaUsuarioPagador": "stri",
  • "participanteDoUsuarioPagador": "stringst",
  • "devedor": {
    },
  • "numeroContrato": "string",
  • "descricao": "string",
  • "permiteNovaTentativa": false,
  • "solicExpiracao": "string"
}

Envio de PAIN.011

Cancelamento da recorrência

Request Body schema: application/json
required
cpfCnpjSolicitanteCancelamento
required
string (cpfCnpj) ^[0-9]{11,14}$
motivoCancelamento
required
string
Enum: "ACCL" "CPCL" "DCSD" "ERSL" "FRUD" "PCFD" "SLCR" "SLDB" "NRES"
idRecorrencia
required
string <= 29 characters

Responses

Request samples

Content type
application/json
{
  • "cpfCnpjSolicitanteCancelamento": "string",
  • "motivoCancelamento": "ACCL",
  • "idRecorrencia": "string"
}

Envio de PAIN.012 - Autorização

Autorização da recorrência

Request Body schema: application/json
required
status
required
boolean
motivoRejeicao
string
Enum: "AC01" "AC04" "AC06" "AG12" "AM05" "AP01" "AP02" "AP03" "AP04" "AP05" "AP06" "AP07" "AP08" "AP10" "AP11" "AP12" "AP13" "AP14" "AP15" "CH16" "DS27" "MD01" "MD20" "RC09" "RC10"
idRecorrencia
required
string <= 29 characters
tipoRecorrencia
string
Value: "RCUR"
tipoFrequencia
string
Enum: "MIAN" "MNTH" "QURT" "WEEK" "YEAR"
dataInicialRecorrencia
string <date>
dataFinalRecorrencia
string or null <date>
indicadorObrigatorioOriginal
boolean
Default: false
valor
number > 0
nomeUsuarioRecebedor
string <= 140 characters
cpfCnpjUsuarioRecebedor
string (cpfCnpj) ^[0-9]{11,14}$
participanteDoUsuarioRecebedor
string = 8 characters
codMunIBGE
string <= 7 characters
cpfCnpjUsuarioPagador
string (cpfCnpj) ^[0-9]{11,14}$
contaUsuarioPagador
string <= 20 characters
agenciaUsuarioPagador
string <= 4 characters
participanteDoUsuarioPagador
string = 8 characters
object
numeroContrato
string <= 35 characters
descricao
string <= 35 characters
jornada
string
Enum: "AUT1" "AUT2" "AUT3" "AUT4"
valorMinimoRecebedor
number > 0

Responses

Request samples

Content type
application/json
{
  • "status": true,
  • "motivoRejeicao": "AC01",
  • "idRecorrencia": "string",
  • "tipoRecorrencia": "RCUR",
  • "tipoFrequencia": "MIAN",
  • "dataInicialRecorrencia": "2019-08-24",
  • "dataFinalRecorrencia": "2019-08-24",
  • "indicadorObrigatorioOriginal": false,
  • "valor": 0,
  • "nomeUsuarioRecebedor": "string",
  • "cpfCnpjUsuarioRecebedor": "string",
  • "participanteDoUsuarioRecebedor": "stringst",
  • "codMunIBGE": "string",
  • "cpfCnpjUsuarioPagador": "string",
  • "contaUsuarioPagador": "string",
  • "agenciaUsuarioPagador": "stri",
  • "participanteDoUsuarioPagador": "stringst",
  • "devedor": {
    },
  • "numeroContrato": "string",
  • "descricao": "string",
  • "jornada": "AUT1",
  • "valorMinimoRecebedor": 0
}

Envio de PAIN.012 - Confirmação

Confirmação de autorização da recorrência

Request Body schema: application/json
required
idRecorrencia
required
string <= 29 characters
dataHoraTipoSituacaoDaRecorrencia
required
string

Responses

Request samples

Content type
application/json
{
  • "idRecorrencia": "string",
  • "dataHoraTipoSituacaoDaRecorrencia": "string"
}

Envio de PAIN.013

Criação da cobrança recorrente

Request Body schema: application/json
required
metodoDePagamento
required
string
Value: "TRF"
dataHoraRecebimentoPeloParticipanteDoUsuarioRecebedor
required
string
prioridadePagamento
required
string
Value: "NORM"
tipoPrioridadePagamento
required
string
Value: "PAGAGD"
idRecorrencia
required
string
idFimAFim
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...
idConciliacaoRecebedor
required
string
valor
required
number > 0
participanteTarifado
required
string
Value: "SLEV"
formaDeIniciacao
required
string
Value: "AUTO"
cpfCnpjUsuarioPagador
required
string (cpfCnpj) ^[0-9]{11,14}$
participanteDoUsuarioPagador
required
string = 8 characters
participanteDoUsuarioRecebedor
required
string = 8 characters
cpfCnpjUsuarioRecebedor
required
string (cpfCnpj) ^[0-9]{11,14}$
contaUsuarioRecebedor
required
string <= 20 characters ^\d+$
agenciaUsuarioRecebedor
string or null <= 4 characters ^\d+$
tipoContaUsuarioRecebedor
required
string
Enum: "CACC" "SVGS" "TRAN"
informacoesEntreUsuarios
string or null <= 140 characters
dataDeVencimento
required
string
object or null
finalidadeDoAgendamento
required
string
Enum: "AGND" "NTAG" "RIFL"
iniciadorDoAgendamento
string <= 14 characters ^\d+$
Default: "00000000000000"

Responses

Request samples

Content type
application/json
{
  • "metodoDePagamento": "TRF",
  • "dataHoraRecebimentoPeloParticipanteDoUsuarioRecebedor": "string",
  • "prioridadePagamento": "NORM",
  • "tipoPrioridadePagamento": "PAGAGD",
  • "idRecorrencia": "string",
  • "idFimAFim": "string",
  • "idConciliacaoRecebedor": "string",
  • "valor": 0,
  • "participanteTarifado": "SLEV",
  • "formaDeIniciacao": "AUTO",
  • "cpfCnpjUsuarioPagador": "string",
  • "participanteDoUsuarioPagador": "stringst",
  • "participanteDoUsuarioRecebedor": "stringst",
  • "cpfCnpjUsuarioRecebedor": "string",
  • "contaUsuarioRecebedor": "string",
  • "agenciaUsuarioRecebedor": "stri",
  • "tipoContaUsuarioRecebedor": "CACC",
  • "informacoesEntreUsuarios": "string",
  • "dataDeVencimento": "string",
  • "devedor": {
    },
  • "finalidadeDoAgendamento": "AGND",
  • "iniciadorDoAgendamento": "00000000000000"
}

Envio de PAIN.014

Resposta para a mensagem PAIN.013

Request Body schema: application/json
required
idFimAFimOriginal
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...
situacaoDoAgendamento
required
string
Enum: "ACSP" "RJCT"
codigoDeErro
string or null
Enum: "AB10" "AC05" "AC06" "AG12" "AM02" "AM09" "DENC" "DS27" "DTED" "DTNT" "FBRD" "IRNT" "MIDI" "MSUC" "NIEC" "NIPA" "NITX" "QUNT" "RC09" "UDEI"
idConciliacaoRecebedorOriginal
required
string <= 35 characters ^\w+$
dataHoraAceitacaoOuRejeicaoDoAgendamento
required
string

Responses

Request samples

Content type
application/json
{
  • "idFimAFimOriginal": "string",
  • "situacaoDoAgendamento": "ACSP",
  • "codigoDeErro": "AB10",
  • "idConciliacaoRecebedorOriginal": "string",
  • "dataHoraAceitacaoOuRejeicaoDoAgendamento": "string"
}

Envio de CAMT.060

Request Body schema: application/json
required
idOriginal
string
tipoConsulta
required
string
Enum: "camt.052" "camt.053" "camt.054"
dataInicialResultado
string
dataFinalResultado
string
horarioInicialResultado
string
horarioFinalResultado
string
tipoArquivo
string
reconciliarTransacao
boolean
Default: false
operationType
string
Value: "SUM"

Responses

Request samples

Content type
application/json
{
  • "idOriginal": "string",
  • "tipoConsulta": "camt.052",
  • "dataInicialResultado": "string",
  • "dataFinalResultado": "string",
  • "horarioInicialResultado": "string",
  • "horarioFinalResultado": "string",
  • "tipoArquivo": "string",
  • "reconciliarTransacao": false,
  • "operationType": "SUM"
}

Envio de CAMT.055

Cancelamento de cobrança recorrente

Request Body schema: application/json
required
idMensagemDoCancelamento
string <= 32 characters
idCancelamentoAgendamento
string
participanteDestinatarioDoCancelamento
required
string = 8 characters
participanteSolicitanteDoCancelamento
required
string = 8 characters
idConciliacaoRecebedorOriginal
required
string <= 35 characters
cpfCnpjUsuarioSolicitanteDoCancelamento
required
string
motivoDoCancelamento
required
string
Enum: "ACCT" "BLCK" "CCLD" "FAIL" "OTHR" "SLBD" "SLCR"
idFimAFimOriginal
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...

Responses

Request samples

Content type
application/json
{
  • "idMensagemDoCancelamento": "string",
  • "idCancelamentoAgendamento": "string",
  • "participanteDestinatarioDoCancelamento": "stringst",
  • "participanteSolicitanteDoCancelamento": "stringst",
  • "idConciliacaoRecebedorOriginal": "string",
  • "cpfCnpjUsuarioSolicitanteDoCancelamento": "string",
  • "motivoDoCancelamento": "ACCT",
  • "idFimAFimOriginal": "string"
}

Envio de CAMT.029

Request Body schema: application/json
required
idCancelamentoAgendamentoOriginal
required
string <= 35 characters
statusDoCancelamento
required
string
Enum: "ACCR" "RJCR"
codigoDeRejeicaoDoCancelamento
string
Enum: "AB09" "AB10" "AG12" "CH16" "CRNC" "DENC" "DS27" "FBRD" "FF08" "PRJL" "RC09" "RC10"

Responses

Request samples

Content type
application/json
{
  • "idCancelamentoAgendamentoOriginal": "string",
  • "statusDoCancelamento": "ACCR",
  • "codigoDeRejeicaoDoCancelamento": "AB09"
}

Envio de PIBR.001

Responses

Envio de REDA.014

Request Body schema: application/json
required
cnpjParticipanteIndireto
required
string^[0-9]{14}$

Responses

Request samples

Content type
application/json
{
  • "cnpjParticipanteIndireto": "string"
}

Envio de REDA.022

Request Body schema: application/json
required
ResponsavelFone
required
string
ResponsavelCelular
required
string
ResponsavelFax
required
string
ResponsavelEmail
required
string <email>
DiretorNome
required
string
DiretorFone
required
string
DiretorCelular
required
string
DiretorEmail
required
string <email>
PalavraChave
required
string <= 8 characters
CpfDiretorEstatutario
required
string^[0-9]{11}$

Responses

Request samples

Content type
application/json
{
  • "ResponsavelFone": "string",
  • "ResponsavelCelular": "string",
  • "ResponsavelFax": "string",
  • "ResponsavelEmail": "[email protected]",
  • "DiretorNome": "string",
  • "DiretorFone": "string",
  • "DiretorCelular": "string",
  • "DiretorEmail": "[email protected]",
  • "PalavraChave": "string",
  • "CpfDiretorEstatutario": "string"
}

Envio de REDA.031

Request Body schema: application/json
required
participanteIndireto
required
string^[0-9]{14}$

Responses

Request samples

Content type
application/json
{
  • "participanteIndireto": "string"
}

Buscar transação por EndToEndId

Retorna todos os dados de uma transação

path Parameters
endToEndId
required
string

Responses

Buscar mensagem por MessageId

Retorna o XML de uma mensagem

path Parameters
msgId
required
string^[M][0-9]{8}[a-zA-Z0-9]{23}$

Responses

Listar transações

Retorna todas as transações de um participante em um período

query Parameters
page
number > 0
Default: 1
limit
number > 0
Default: 1000
startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

DICT-Chaves

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Buscar Chave Pix

Obtém os detalhes de uma chave Pix

path Parameters
required
string or string or string or string
header Parameters
onz-payerid
required
string
onz-endtoendid
string (onz-payerid) ^[0-9]{11,14}$
onz-includestatistics
boolean
Default: false

Responses

Atualizar Chave Pix

Realiza a atualização dos dados de uma chave Pix

path Parameters
required
string or string or string or string
Request Body schema: application/json
required
Type
string
Enum: "NATURAL_PERSON" "LEGAL_PERSON"
TaxIdNumber
string
Name
string
TradeName
string
Branch
string = 4 characters ^\d+$
AccountNumber
string [ 1 .. 20 ] characters ^\d+$
AccountType
string
Enum: "SLRY" "SVGS" "CACC" "TRAN"
OpeningDate
string
Reason
required
string
Enum: "USER_REQUESTED" "BRANCH_TRANSFER" "RECONCILIATION"

Responses

Request samples

Content type
application/json
{
  • "Type": "NATURAL_PERSON",
  • "TaxIdNumber": "string",
  • "Name": "string",
  • "TradeName": "string",
  • "Branch": "stri",
  • "AccountNumber": "string",
  • "AccountType": "SLRY",
  • "OpeningDate": "string",
  • "Reason": "USER_REQUESTED"
}

Buscar Chave Pix por Agência e Conta

Realiza a busca de uma chave Pix no ambiente do DICT por agência e conta

path Parameters
agency
required
string = 4 characters ^\d+$
account
required
string [ 1 .. 20 ] characters ^\d+$
header Parameters
onz-payerid
required
string

Responses

Consultar Política

Obtém o estado atual do balde do participante para a política informada.

path Parameters
policy
required
string <= 256 characters

Responses

Listar Políticas

Obtém a lista de políticas de limitação de acesso ao DICT para o participante requisitante.

Responses

Criar Chave Pix

Cria uma nova chave Pix no ambiente do DICT.

Request Body schema: application/json
required
string or string or string or string
KeyType
required
string
Enum: "CPF" "CNPJ" "PHONE" "EMAIL" "EVP"
Branch
required
string = 4 characters ^\d+$
AccountNumber
required
string [ 1 .. 20 ] characters ^\d+$
AccountType
required
string
Enum: "SLRY" "SVGS" "CACC" "TRAN"
Type
required
string
Enum: "LEGAL_PERSON" "NATURAL_PERSON"
OpeningDate
required
string <date-time>
Name
required
string [ 1 .. 120 ] characters
TradeName
string <= 100 characters
TaxIdNumber
required
string (cpfCnpj) ^[0-9]{11,14}$
Reason
required
string
Enum: "USER_REQUESTED" "RECONCILIATION"

Responses

Request samples

Content type
application/json
{
  • "Key": "string",
  • "KeyType": "CPF",
  • "Branch": "stri",
  • "AccountNumber": "string",
  • "AccountType": "SLRY",
  • "Type": "LEGAL_PERSON",
  • "OpeningDate": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "TradeName": "string",
  • "TaxIdNumber": "string",
  • "Reason": "USER_REQUESTED"
}

Listar Chaves Pix

Listar as chaves Pix cadastradas para o usuário

Request Body schema: application/json
Page
number
Default: 1
PerPage
number <= 350
Default: 10
Filter
string
Array of objects
Default: []
ExportCSV
boolean
InitialDate
string <date-time>
FinalDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "Page": 1,
  • "PerPage": 10,
  • "Filter": "string",
  • "QueryFilter": [ ],
  • "ExportCSV": true,
  • "InitialDate": "2019-08-24T14:15:22Z",
  • "FinalDate": "2019-08-24T14:15:22Z"
}

Verificar existência de chaves

Consulta a existência de um conjunto de chaves no diretório de identificadores.

Request Body schema: application/json
required
required
Array of objects
Array
required
string or string or string or string
Any of
string

Responses

Request samples

Content type
application/json
{
  • "Keys": [
    ]
}

Deletar Chave Pix

Realiza a exclusão de uma chave Pix

path Parameters
required
string or string or string or string
reason
required
string
Enum: "USER_REQUESTED" "ACCOUNT_CLOSURE" "BRANCH_TRANSFER" "RECONCILIATION" "FRAUD"
header Parameters
onz-taxidnumber
string

Responses

DICT-Estatísticas

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Consultar Estatísticas de usuário final

Obtém dados estatísticos de perfil de uso do usuário (liquidações, fraudes reportadas e fraudes confirmadas).

path Parameters
document
required
string
query Parameters
date
string^\d{4}-\d{2}-\d{2}$

Responses

DICT-QRCodes

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Consulta de QRCode

Realiza a consulta de um QRCode através do código BRCode

header Parameters
onz-payerid
required
string
Request Body schema: application/json
required
brCode
required
string
codMun
required
string = 7 characters
DPP
string
Default: "2024-02-05"

Responses

Request samples

Content type
application/json
{
  • "brCode": "string",
  • "codMun": "strings",
  • "DPP": "2024-02-05"
}

DICT-Antifraude

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Criar Marcação de Fraude

Cria uma marcação de fraude para um usuário ou chave específica.

Request Body schema: application/json
required
object
RequestId
required
string <uuid>

Identificador único da requisição para garantir idempotência

Responses

Request samples

Content type
application/json
{
  • "FraudMarker": {
    },
  • "RequestId": "1c78724c-7485-44ae-8ae2-a5c5c92d2d9a"
}

Consultar Marcação de Fraude

Obtém detalhes de uma marcação de fraude específica.

path Parameters
FraudMarkerId
required
string <uuid>

Responses

Cancelar Marcação de Fraude

Cancela uma marcação de fraude existente.

path Parameters
FraudMarkerId
required
string <uuid>

Responses

Consultar Estatísticas de Pessoa

Obtém dados estatísticos de um usuário final.

path Parameters
TaxIdNumber
required
string^[0-9]{11,14}$

Responses

Consultar Estatísticas de Chave Registrada

Obtém dados estatísticos relacionados a uma chave registrada.

path Parameters
Key
required
string <= 77 characters

Responses

DICT-Infrações

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Consultar Relato de Infração

Obtém detalhes de um relato de infração.

path Parameters
id
required
string <uuid>

Responses

Criar Relato de Infração

Cria um relato de infração. Tanto o participante debitado quanto o creditado podem criar um relato de infração.

Request Body schema: application/json
required
TransactionId
required
string
ReportDetails
required
string <= 2000 characters
InfractionType
required
string
Enum: "REFUND_REQUEST" "REFUND_CANCELLED"
SituationType
required
string
Enum: "SCAM" "ACCOUNT_TAKEOVER" "COERCION" "FRAUDULENT_ACCESS" "OTHER"
Phone
required
string <= 16 characters ^\+[0-9]\d{1,14}$
Email
required
string <= 256 characters ^[a-z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-z0-9](?:[a...

Responses

Request samples

Content type
application/json
{
  • "TransactionId": "string",
  • "ReportDetails": "string",
  • "InfractionType": "REFUND_REQUEST",
  • "SituationType": "SCAM",
  • "Phone": "string",
  • "Email": "string"
}

Listar Relatos de Infração

Obtém lista de relatos de infração em que o participante é parte.

Request Body schema: application/json
Page
number
Default: 1
PerPage
number <= 350
Default: 10
Filter
string
Array of objects
Default: []
ExportCSV
boolean
InitialDate
string <date-time>
FinalDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "Page": 1,
  • "PerPage": 10,
  • "Filter": "string",
  • "QueryFilter": [ ],
  • "ExportCSV": true,
  • "InitialDate": "2019-08-24T14:15:22Z",
  • "FinalDate": "2019-08-24T14:15:22Z"
}

Fechar Relato de Infração

Fecha o relato de infração. Se o relato foi criado pelo participante debitado, o creditado deve realizar o fechamento e vice-versa. O campo FraudType é obrigatório quando o relato é fechado com o resultado AGREED.

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
AnalysisDetails
required
string <= 2000 characters
AnalysisResult
required
string
Enum: "AGREED" "DISAGREED"
FraudType
string
Enum: "APPLICATION_FRAUD" "MULE_ACCOUNT" "SCAMMER_ACCOUNT" "OTHER"

Responses

Request samples

Content type
application/json
{
  • "AnalysisDetails": "string",
  • "AnalysisResult": "AGREED",
  • "FraudType": "APPLICATION_FRAUD"
}

Cancelar Relato de Infração

Cancela o relato de infração. Só pode ser realizada pelo participante que criou o relato.

path Parameters
id
required
string <uuid>

Responses

DICT-Devoluções

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Consultar solicitação de devolução

Obtém detalhes de uma solicitação de devolução.

path Parameters
id
required
string <uuid>

Responses

Criar uma Solicitação de Devolução

Cria uma Solicitação de devolução. Apenas o participante debitado pode criar uma Solicitação de devolução.

Request Body schema: application/json
required
TransactionId
required
string
RefundReason
required
string
Enum: "FRAUD" "OPERATIONAL_FLAW" "REFUND_CANCELLED"
RefundAmount
required
number > 0
RefundDetails
required
string <= 2000 characters

Responses

Request samples

Content type
application/json
{
  • "TransactionId": "string",
  • "RefundReason": "FRAUD",
  • "RefundAmount": 0,
  • "RefundDetails": "string"
}

Cancelar solicitação de devolução

Cancela a Solicitação de devolução. Só pode ser realizada pelo participante que criou a solicitação.

path Parameters
id
required
string <uuid>

Responses

Fechar solicitação de devolução

Fecha a solicitação de devolução. A solicitação só pode ser fechada pelo participante contestado.

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
RefundAnalysisResult
required
string
Enum: "TOTALLY_ACCEPTED" "PARTIALLY_ACCEPTED" "REJECTED"
RefundAnalysisDetails
string <= 2000 characters
RefundTransactionId
string
RefundRejectionReason
string
Enum: "NO_BALANCE" "ACCOUNT_CLOSURE" "CANNOT_REFUND" "OTHER"

Responses

Request samples

Content type
application/json
{
  • "RefundAnalysisResult": "TOTALLY_ACCEPTED",
  • "RefundAnalysisDetails": "string",
  • "RefundTransactionId": "string",
  • "RefundRejectionReason": "NO_BALANCE"
}

Listar Requisições de Devolução

Obtém lista de requisições de devolução em que o participante é parte.

Request Body schema: application/json
Page
number
Default: 1
PerPage
number <= 350
Default: 10
Filter
string
Array of objects
Default: []
ExportCSV
boolean
InitialDate
string <date-time>
FinalDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "Page": 1,
  • "PerPage": 10,
  • "Filter": "string",
  • "QueryFilter": [ ],
  • "ExportCSV": true,
  • "InitialDate": "2019-08-24T14:15:22Z",
  • "FinalDate": "2019-08-24T14:15:22Z"
}

DICT-Reconciliações

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

DICT-Reivindicações

Requests para interação com o Diretório de Identificadores de Contas Transacionais (DICT)

Consultar Reivindicação

Obtém detalhes de uma reivindicação.

path Parameters
id
required
string <uuid>

Responses

Response Schema: application/json
Id
string <uuid>
Type
string
Enum: "PORTABILITY" "OWNERSHIP"
Key
string
KeyType
string
Enum: "CNPJ" "CPF" "EMAIL" "PHONE" "EVP"
ClaimerParticipant
string
ClaimerBranch
string
ClaimerAccountNumber
string
ClaimerAccountType
string
Enum: "TRAN" "CACC" "SLRY" "SVGS"
ClaimerOpeningDate
string <date-time>
ClaimerType
string
Enum: "LEGAL_PERSON" "NATURAL_PERSON"
ClaimerTaxIdNumber
string
ClaimerName
string
Status
string
Enum: "OPEN" "COMPLETED" "CANCELLED" "CONFIRMED" "WAITING_RESOLUTION"
CompletionPeriodEnd
string or null <date-time>
ResolutionPeriodEnd
string or null <date-time>
DonorParticipant
string
DonorBranch
string
DonorAccountNumber
string
DonorAccountType
string
Enum: "TRAN" "CACC" "SLRY" "SVGS"
DonorOpeningDate
string <date-time>
DonorType
string
Enum: "LEGAL_PERSON" "NATURAL_PERSON"
DonorTaxIdNumber
string
DonorName
string
RelatedParticipant
string
LastModified
string <date-time>
CreatedAt
string <date-time>
UpdatedAt
string <date-time>
ParticipantName
string
ParticipantNameDonor
string
IsInternalToExternal
boolean
isClaimer
boolean

Response samples

Content type
application/json
{
  • "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
  • "Type": "PORTABILITY",
  • "Key": "string",
  • "KeyType": "CNPJ",
  • "ClaimerParticipant": "string",
  • "ClaimerBranch": "string",
  • "ClaimerAccountNumber": "string",
  • "ClaimerAccountType": "TRAN",
  • "ClaimerOpeningDate": "2019-08-24T14:15:22Z",
  • "ClaimerType": "LEGAL_PERSON",
  • "ClaimerTaxIdNumber": "string",
  • "ClaimerName": "string",
  • "Status": "OPEN",
  • "CompletionPeriodEnd": "2019-08-24T14:15:22Z",
  • "ResolutionPeriodEnd": "2019-08-24T14:15:22Z",
  • "DonorParticipant": "string",
  • "DonorBranch": "string",
  • "DonorAccountNumber": "string",
  • "DonorAccountType": "TRAN",
  • "DonorOpeningDate": "2019-08-24T14:15:22Z",
  • "DonorType": "LEGAL_PERSON",
  • "DonorTaxIdNumber": "string",
  • "DonorName": "string",
  • "RelatedParticipant": "string",
  • "LastModified": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "ParticipantName": "string",
  • "ParticipantNameDonor": "string",
  • "IsInternalToExternal": true,
  • "isClaimer": true
}

Confirmar Reivindicação

Confirma a operação de reivindicação. Como consequência, vínculo da chave com participante doador é removido.

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
Reason
required
string
Enum: "USER_REQUESTED" "ACCOUNT_CLOSURE" "FRAUD" "DEFAULT_OPERATION" "RECONCILIATION"

Responses

Request samples

Content type
application/json
{
  • "Reason": "USER_REQUESTED"
}

Cancelar Reivindicação

Cancela reivindicação.

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
Reason
required
string
Enum: "USER_REQUESTED" "ACCOUNT_CLOSURE" "FRAUD" "DEFAULT_OPERATION" "RECONCILIATION"

Responses

Request samples

Content type
application/json
{
  • "Reason": "USER_REQUESTED"
}

Criar Reivindicação

Cria uma nova reivindicação.

Request Body schema: application/json
required
required
string or string or string or string
KeyType
required
string
Enum: "CPF" "CNPJ" "PHONE" "EMAIL" "EVP"
Branch
required
string^\d{4}$
AccountNumber
required
string^\d{1,20}$
AccountType
required
string
Enum: "CACC" "TRAN" "SLRY" "SVGS"
OpeningDate
required
string
ClaimerType
required
string
Enum: "NATURAL_PERSON" "LEGAL_PERSON"
Type
required
string
Enum: "OWNERSHIP" "PORTABILITY"
required
string or string
Name
required
string

Responses

Request samples

Content type
application/json
{
  • "Key": "string",
  • "KeyType": "CPF",
  • "Branch": "string",
  • "AccountNumber": "string",
  • "AccountType": "CACC",
  • "OpeningDate": "string",
  • "ClaimerType": "NATURAL_PERSON",
  • "Type": "OWNERSHIP",
  • "TaxIdNumber": "stringstrin",
  • "Name": "string"
}

Listar Reivindicações

Obtém uma lista de reivindicações, ordenada de forma crescente pelo campo LastModified, de acordo com os filtros passados.

Request Body schema: application/json
Page
number
Default: 1
PerPage
number <= 350
Default: 25
Filter
string
Array of objects
Default: []

Responses

Request samples

Content type
application/json
{
  • "Page": 1,
  • "PerPage": 25,
  • "Filter": "string",
  • "QueryFilter": [ ]
}

Legado

Endpoints legados

Efetuar login na plataforma

Request Body schema: application/json
required
usuario
required
string
senha
required
string

Responses

Response Schema: application/json
logado
required
boolean
token
required
string

Request samples

Content type
application/json
{
  • "usuario": "string",
  • "senha": "string"
}

Response samples

Content type
application/json
{
  • "logado": true,
  • "token": "string"
}

Consultar mensagens de um endToEndId

Obtém todas mensagens relacionadas ao endToEndId requisitado

path Parameters
endToEndId
required
string

Responses

Envio de PACS.002

Resposta para as mensagens PACS.008 e PACS.004

Request Body schema: application/json
required
idInstrucaoOriginal
required
string
idFimAFimOriginal
required
string (idFimAFim) /[E|D][0-9]{8}[0-9]{4}[0-1][0-9][0-3][0-9][0-...
situacaoDaTransacao
required
string
Enum: "ACSP" "RJCT"
codigoDeErro
string
Enum: "AB09" "AB03" "AC03" "AC06" "AC07" "AC14" "AG03" "AM02" "AM09" "BE01" "BE17" "CH11" "DS04" "DS24" "DT05" "RR04" "SL02" ""

Responses

Request samples

Content type
application/json
{
  • "idInstrucaoOriginal": "string",
  • "idFimAFimOriginal": "string",
  • "situacaoDaTransacao": "ACSP",
  • "codigoDeErro": "AB09"
}

Envio de PACS.004

Devolução de valores

Request Body schema: application/json
required
endToEndID
string
idFimAFim
required
string
valor
required
number > 0
codigoDevolucao
required
string
motivoDevolucao
string
Default: ""
participanteUsuarioPagador
required
string
participanteUsuarioRecebedor
required
string

Responses

Request samples

Content type
application/json
{
  • "endToEndID": "string",
  • "idFimAFim": "string",
  • "valor": 0,
  • "codigoDevolucao": "string",
  • "motivoDevolucao": "",
  • "participanteUsuarioPagador": "string",
  • "participanteUsuarioRecebedor": "string"
}

Envio de PACS.008

Transferência de valores

Request Body schema: application/json
required
idConciliacaoRecebedor
string or null^\w+$|^$
valor
required
number > 0
nomeUsuarioPagador
required
string
cpfCnpj
required
string
contaUsuarioPagador
required
string <= 20 characters ^\d+$
agenciaUsuarioPagador
required
string <= 4 characters ^\d+$
tipoContaUsuarioPagador
required
string
Enum: "CACC" "SLRY" "SVGS" "TRAN"
participanteDoUsuarioPagador
required
string = 8 characters
participanteDoUsuarioRecebedor
required
string = 8 characters
cpfCnpjUsuarioRecebedor
required
string (cpfCnpj) ^[0-9]{11,14}$
contaUsuarioRecebedor
required
string <= 20 characters ^\d+$
agenciaUsuarioRecebedor
required
string <= 4 characters ^\d+$
tipoContaUsuarioRecebedor
required
string
Enum: "CACC" "SLRY" "SVGS" "TRAN"
informacoesEntreUsuarios
string
Default: ""
idContaTransacional
string
formaDeIniciacao
required
string
Enum: "MANU" "DICT" "INIC" "QRDN" "QRES" "QRPG"
finalidadeDaTransacao
required
string
Enum: "IPAY" "GSCB" "OTHR"
modalidadeAgente
string
Enum: "AGFSS" "AGTEC" "AGTOT"
prestadorDoServicoDeSaque
string
Array of objects
tipoPrioridadePagamento
string
Default: "PAGPRI"
Enum: "PAGPRI" "PAGFRD" "PAGAGD"
endToEndID
string (cpfCnpj) ^[0-9]{11,14}$
cnpjIniciadorPagamento
string (cpfCnpj) ^[0-9]{11,14}$
recebimento
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "idConciliacaoRecebedor": "string",
  • "valor": 0,
  • "nomeUsuarioPagador": "string",
  • "cpfCnpj": "string",
  • "contaUsuarioPagador": "string",
  • "agenciaUsuarioPagador": "stri",
  • "tipoContaUsuarioPagador": "CACC",
  • "participanteDoUsuarioPagador": "stringst",
  • "participanteDoUsuarioRecebedor": "stringst",
  • "cpfCnpjUsuarioRecebedor": "string",
  • "contaUsuarioRecebedor": "string",
  • "agenciaUsuarioRecebedor": "stri",
  • "tipoContaUsuarioRecebedor": "CACC",
  • "informacoesEntreUsuarios": "",
  • "idContaTransacional": "string",
  • "formaDeIniciacao": "MANU",
  • "finalidadeDaTransacao": "IPAY",
  • "modalidadeAgente": "AGFSS",
  • "prestadorDoServicoDeSaque": "string",
  • "informacoesValor": [
    ],
  • "tipoPrioridadePagamento": "PAGPRI",
  • "endToEndID": "string",
  • "cnpjIniciadorPagamento": "string",
  • "recebimento": "2019-08-24T14:15:22Z"
}

Listar Relatos de Infração

Obtém lista de relatos de infração em que o participante é parte.

Request Body schema: application/json
pagina
number > 0
Default: 1
filtro
string
Default: "%"

Responses

Request samples

Content type
application/json
{
  • "pagina": 1,
  • "filtro": "%"
}