Skip to main content
API docs by Redocly

QRCodes Produção (1.0.0)

Download OpenAPI specification:Download

Gerenciamento de notificações

Configurar o Webhook Pix

Authorizations:
oauth2Auth
path Parameters
chavepix
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{}

Cancelar o webhook Pix

Authorizations:
oauth2Auth
path Parameters
chavepix
required
string

Responses

Exibir informações acerca do Webhook Pix

Authorizations:
oauth2Auth

Responses

Gerenciamento de cobranças para pagamento imediato

Criar cobrança imediata

Authorizations:
oauth2Auth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "calendario": {
    },
  • "valor": {
    },
  • "chave": "{chavepix}"
}

Consultar lista de cobranças imediatas

Authorizations:
oauth2Auth
query Parameters
inicio
string
Example: inicio=2024-10-10T00:00:00Z
fim
string
Example: fim=2024-10-17T03:00:00Z

Responses

Criar cobrança imediata

Authorizations:
oauth2Auth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "calendario": {
    },
  • "valor": {
    },
  • "chave": "{chavepix}"
}

Revisar cobrança imediata

Authorizations:
oauth2Auth
path Parameters
txId
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "calendario": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "{CHAVEPIX}"
}

Consultar cobrança imediata

Authorizations:
oauth2Auth

Responses

Gerenciamento de Pix recebidos

Consultar Pix

Authorizations:
oauth2Auth

Responses

Consultar Pix recebidos

Authorizations:
oauth2Auth
query Parameters
inicio
string
Example: inicio=2024-10-10T00:00:00Z
fim
string
Example: fim=2024-10-17T23:59:00Z

Responses

Solicitar devolução

Authorizations:
oauth2Auth
path Parameters
ENDtoEND
required
string
ID_Devolucao
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "valor": "100.00"
}

Criar cobrança com vencimento

Consultar cobrança com vencimento

Authorizations:
oauth2Auth

Responses

Criar cobrança com vencimento

Authorizations:
oauth2Auth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "devedor": {
    },
  • "valor": {
    }
}

Criar cobrança com vencimento Copy

Authorizations:
oauth2Auth
path Parameters
txid-26a32-caract
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "calendario": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "{CHAVEPIX}",
  • "solicitacaoPagador": "Que cor você deseja?"
}

Consultar lista de cobranças com vencimento

Authorizations:
oauth2Auth
query Parameters
inicio
string
Example: inicio=2024-10-10T00:00:00Z
fim
string
Example: fim=2024-10-17T00:00:00Z

Responses

Autorização

Token

Authorizations:
oauth2Auth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "client_id": "11183490007473735000181",
  • "client_secret": "GZiNjI2YjgtMzIzYS00NWQzLWIzZmItY",
  • "grant_type": "client_credentials"
}