Download OpenAPI specification:
API para geração de PIX QR CODE
Autenticação:
Sandbox: https://api2.cielo.com.br/sandbox/v2
Produção: https://api2.cielo.com.br/v2
Api:
Callback de Notificação:
Na seção Webhook dentro do método Put, há uma aba denominada Callbacks.
Nesta aba é definido o callback que será enviado para o endereço cadastrado no webhook.
Endpoint para criar um access token
grant_type | string (GrantType) Default: "client_credentials" Tipo de fluxo de autenticação oauth |
{- "grant_type": "client_credentials"
}
{- "access_token": "24c18dab-e8ad-4627-b181-540009c95892",
- "token_type": "bearer",
- "expires_in": "3600"
}
Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.
required | object (Expiração) |
Pessoa Física (object) or Pessoa Jurídica (object) | |
required | object (Valor da cobrança imediata) valores monetários referentes à cobrança. |
chave required | string (Chave DICT do recebedor) <= 77 characters Formato do campo chave
|
solicitacaoPagador | string (Solicitação ao pagador) <= 140 characters O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "calendario": {
- "expiracao": "3600"
}, - "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
{- "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "expiracao": "3600"
}, - "txid": "string",
- "revisao": 0,
- "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob"
}, - "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "status": "ATIVA",
- "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "pixCopiaECola": "string",
- "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
Endpoint para criar uma cobrança imediata.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo |
required | object (Expiração) |
Pessoa Física (object) or Pessoa Jurídica (object) | |
required | object (Valor da cobrança imediata) valores monetários referentes à cobrança. |
chave required | string (Chave DICT do recebedor) <= 77 characters Formato do campo chave
|
solicitacaoPagador | string (Solicitação ao pagador) <= 140 characters O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "calendario": {
- "expiracao": "3600"
}, - "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
{- "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "expiracao": "3600"
}, - "txid": "string",
- "revisao": 0,
- "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob"
}, - "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "status": "ATIVA",
- "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "pixCopiaECola": "string",
- "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo |
object (Expiração) | |
Pessoa Física (object) or Pessoa Jurídica (object) | |
object | |
status | string (Status do registro da cobrança) Value: "REMOVIDA_PELO_USUARIO_RECEBEDOR" |
object (Valor da cobrança imediata) valores monetários referentes à cobrança. | |
chave | string (Chave DICT do recebedor) <= 77 characters Formato do campo chave
|
solicitacaoPagador | string (Solicitação ao pagador) <= 140 characters O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "calendario": {
- "expiracao": "3600"
}, - "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0
}, - "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
- "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
{- "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "expiracao": "3600"
}, - "txid": "string",
- "revisao": 0,
- "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob"
}, - "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "status": "ATIVA",
- "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "pixCopiaECola": "string",
- "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
]
}
Endpoint para consultar uma cobrança através de um determinado txid.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo |
revisao | integer <int32> (Revisão) O campo
|
{- "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "expiracao": "3600"
}, - "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob"
}, - "valor": {
- "original": "string",
- "modalidadeAlteracao": 1
}, - "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
], - "txid": "string",
- "revisao": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "status": "ATIVA",
- "pixCopiaECola": "string",
- "pix": [
- {
- "endToEndId": "stringstringstringstringstringst",
- "txid": "string",
- "valor": "string",
- "componentesValor": {
- "original": {
- "valor": "string"
}, - "saque": {
- "valor": "string",
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "valor": "string",
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string",
- "juros": {
- "valor": "string"
}, - "multa": {
- "valor": "string"
}, - "abatimento": {
- "valor": "string"
}, - "desconto": {
- "valor": "string"
}
}, - "chave": "string",
- "horario": "2019-08-24T14:15:22Z",
- "infoPagador": "string",
- "devolucoes": [
- {
- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "string",
- "natureza": "ORIGINAL",
- "descricao": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z",
- "liquidacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "Negado por timeout"
}
]
}
]
}
Endpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será "Devolução solicitada pelo usuário recebedor do pagamento original" cuja sigla é "MD06" de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix.
e2eid required | string (Id fim a fim da transação) = 32 characters [a-zA-Z0-9]{32} EndToEndIdentification que transita na PACS002, PACS004 e PACS008 |
id required | string (Id da Devolução) [a-zA-Z0-9]{1,35} Id gerado pelo cliente para representar unicamente uma devolução. |
valor required | string (Valor) \d{1,10}\.\d{2} Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix. |
natureza | string (Natureza da Devolução Solicitada) Enum: "ORIGINAL" "RETIRADA" Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix
comum (com código: As naturezas são assim definidas:
Os valores de devoluções são sempre limitados aos valores máximos a seguir:
|
descricao | string (Mensagem ao pagador relativa à devolução.) <= 140 characters O campo |
{- "valor": "string",
- "natureza": "ORIGINAL",
- "descricao": "string"
}
{- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "10.23",
- "natureza": "ORIGINAL",
- "descricao": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z",
- "liquidacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "string"
}
Endpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devolução
e2eid required | string (Id fim a fim da transação) = 32 characters [a-zA-Z0-9]{32} EndToEndIdentification que transita na PACS002, PACS004 e PACS008 |
id required | string (Id da Devolução) [a-zA-Z0-9]{1,35} Id gerado pelo cliente para representar unicamente uma devolução. |
{- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "10.23",
- "natureza": "ORIGINAL",
- "descricao": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z",
- "liquidacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "string"
}
Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.
inicio required | string <date-time> (Data de início) Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339. |
fim required | string <date-time> (Data de fim) Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339. |
cpf | string (CPF) /^\d{11}$/ Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ. |
cnpj | string (CNPJ) /^\d{14}$/ Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF. |
locationPresente | boolean |
status | string (Status do registro da cobrança) Filtro pelo status da cobrança. |
paginacao.paginaAtual | integer <int32> (Página atual) >= 0 Default: 0 Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0. |
paginacao.itensPorPagina | integer <int32> (Itens por Página) [ 1 .. 1000 ] Default: 100 Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros. |
{- "parametros": {
- "inicio": "2020-04-01T20:15:00.358Z",
- "fim": "2020-04-01T20:15:00.358Z",
- "cpf": "string",
- "cnpj": "string",
- "locationPresente": true,
- "status": "string",
- "paginacao": {
- "paginaAtual": 0,
- "itensPorPagina": 1,
- "quantidadeDePaginas": 1,
- "quantidadeTotalDeItens": 0
}
}, - "cobs": [
- {
- "calendario": {
- "criacao": "2019-08-24T14:15:22Z",
- "expiracao": "3600"
}, - "devedor": {
- "cpf": "string",
- "nome": "string"
}, - "loc": {
- "id": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob",
- "criacao": "2019-08-24T14:15:22Z"
}, - "valor": {
- "original": "string",
- "modalidadeAlteracao": 1,
- "retirada": {
- "saque": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "troco": {
- "valor": "string",
- "modalidadeAlteracao": 0,
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}
}
}, - "chave": "string",
- "solicitacaoPagador": "string",
- "infoAdicionais": [
- {
- "nome": "string",
- "valor": "string"
}
], - "txid": "string",
- "revisao": 0,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "status": "ATIVA",
- "pixCopiaECola": "string",
- "pix": [
- {
- "endToEndId": "stringstringstringstringstringst",
- "txid": "string",
- "valor": "string",
- "horario": "2019-08-24T14:15:22Z",
- "infoPagador": "string",
- "devolucoes": [
- {
- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z",
- "liquidacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "Negado por timeout"
}
]
}
]
}
]
}
Endpoint para consultar um Pix através de um e2eid.
e2eid required | string (Id fim a fim da transação) EndToEndIdentification que transita na PACS002, PACS004 e PACS008 |
{- "endToEndId": "E01027058202505231200XXXXXXXXXXX",
- "txid": "1232c88b8f1e6ec4ddd9361e7faed7b24b2",
- "valor": "10.23",
- "componentesValor": {
- "original": {
- "valor": "string"
}
}, - "chave": "string",
- "horario": "2019-08-24T14:15:22Z",
- "infoPagador": "string",
- "devolucoes": [
- {
- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "10.23",
- "natureza": "ORIGINAL",
- "descricao": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z",
- "liquidacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "string"
}
]
}
Endpoint para consultar Pix recebidos
inicio required | string <date-time> (Data de início) Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339. |
fim required | string <date-time> (Data de fim) Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339. |
txid | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo |
txIdPresente | boolean |
devolucaoPresente | boolean |
cpf | string (CPF) /^\d{11}$/ Filtro pelo CPF do pagador. Não pode ser utilizado ao mesmo tempo que o CNPJ. |
cnpj | string (CNPJ) /^\d{14}$/ Filtro pelo CNPJ do pagador. Não pode ser utilizado ao mesmo tempo que o CPF. |
paginacao.paginaAtual | integer <int32> (Página atual) >= 0 Default: 0 Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0. |
paginacao.itensPorPagina | integer <int32> (Itens por Página) [ 1 .. 1000 ] Default: 100 Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros. |
{- "parametros": {
- "inicio": "2020-01-01T20:15:00.358Z",
- "fim": "2020-12-01T20:15:00.358Z",
- "paginacao": {
- "paginaAtual": 0,
- "itensPorPagina": 1,
- "quantidadeDePaginas": 1,
- "quantidadeTotalDeItens": 0
}
}, - "pix": [
- {
- "endToEndId": "E01027058202505231200XXXXXXXXXXX",
- "txid": "1232c88b8f1e6ec4ddd9361e7faed7b24b2",
- "valor": "10.23",
- "componentesValor": {
- "original": {
- "valor": "string"
}, - "saque": {
- "valor": "string",
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string"
}, - "valor": "string",
- "modalidadeAgente": "AGTEC",
- "prestadorDoServicoDeSaque": "string",
- "juros": {
- "valor": "string"
}, - "multa": {
- "valor": "string"
}, - "abatimento": {
- "valor": "string"
}, - "desconto": {
- "valor": "string"
}
}, - "chave": "string",
- "horario": "2019-08-24T14:15:22Z",
- "infoPagador": "string",
- "devolucoes": [
- {
- "id": "string",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "string",
- "natureza": "ORIGINAL",
- "descricao": "string",
- "horario": {
- "solicitacao": "2019-08-24T14:15:22Z"
}, - "status": "EM_PROCESSAMENTO",
- "motivo": "string"
}
]
}
]
}
Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.
chave required | string (Chave DICT do recebedor) <= 77 characters |
webhookUrl required | string <uri> |
{
}
{- "title": "Webhook inválido.",
- "status": 400,
- "detail": "A presente requisição busca criar um webhook sem respeitar o _schema_ ou, ainda, com sentido semanticamente inválido."
}
{- "pix": [
- {
- "allOf": [
- {
- "$ref": "#/components/examples/pixWebhook1/value"
}
]
}, - {
- "allOf": [
- {
- "$ref": "#/components/examples/pixWebhook2/value"
}
]
}
]
}
Endpoint para recuperação de informações sobre o Webhook Pix.
chave required | string (Chave DICT do recebedor) <= 77 characters |
{- "chave": "40a0932d-1918-4eee-845d-35a2da1690dc",
- "criacao": "2020-11-11T10:15:00.358Z"
}
Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.
O PSP recebedor está livre para remover unilateralmente um webhook que esteja associado a uma chave que não pertence mais a este usuário recebedor.
chave required | string (Chave DICT do recebedor) <= 77 characters |
{- "title": "string",
- "status": 0,
- "detail": "string"
}