Infopago API Docs
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
  1. Authentication
  • Manual Api Contas
    • Authentication
      • Obter um token de acesso.
        POST
    • Accounts
      • Obter transações da conta do cliente.
      • Obter detalhes da transação.
      • Obter saldo da conta do cliente.
      • Obter dados consolidados do extrato do cliente.
    • Pix
      • Iniciar um pagamento por QR Code.
      • Iniciar um pagamento usando dados bancários.
      • Iniciar um pagamento por chave Pix.
      • Obter detalhes da transação por end-to-end-id.
      • Obter detalhes da transação por chave de idempotência.
      • Obter o comprovante de pagamento Pix em formato PDF.
      • Verificar informações do QRCode via Copia e Cola
    • Billets
      • Iniciar um pagamento usando dados do boleto.
      • Obter uma lista de pagamentos de boletos.
      • Obter dados da operação de pagamento de boleto por ID.
      • Obter o comprovante de pagamento de boleto em formato PDF.
    • Infractions
      • Retorna infrações abertas contra a conta do cliente.
      • Obter dados da infração pelo ID da infração.
      • Criar uma defesa contra uma infração.
    • Webhooks
      • Obter uma lista de webhooks.
      • Obter os dados de um webhook.
      • Remover um webhook.
      • Criar webhooks para operações de transferência.
      • Criar webhooks para operações de recebimento.
      • Criar webhooks para operações de devolução.
      • Criar webhooks para operações de cash-out.
      • Criar webhooks para operações de infração.
    • Internal Transfers
      • Criar uma transferência interna
      • Obter transferência interna por EndToEndId
      • Obter transferência interna por chave de idempotência
  • Esquemas
    • RequestBodies
      • AuthData
      • WebhookData
      • WebhookPayload
      • CashOutWebhookPayload
      • InfractionWebhookPayload
      • PixQrcData
      • PixManuData
      • PixDictData
      • BilletPaymentRegisterRequest
      • BilletData
    • Token
    • creditDebitType
    • AccountType
    • IspbDenyList
    • Ispb
    • Issuer
    • AccountNumber
    • PixCashOutExpiration
    • RemittanceInformation
    • DebtorData
    • CreditorData
    • Transactions
    • EndToEndId
    • IdempotencyKey
    • TxId
    • Balances
    • TransactionType
    • TransactionData
    • TransactionDetailsData
    • BalanceData
    • MetaBalances
    • Statements
    • StatementData
    • ConsolidatedStatements
    • ConsolidatedStatementData
    • LocalInstrumentType
    • InfractionListData
    • InfractionDetailBodyData
    • InfractionDefenseHistoryData
    • InfractionDefenseHistoryAttachmentsData
    • InfractionBodyData
    • InfractionData
    • OperationStatus
    • InfractionStatus
    • InfractionTypes
    • InfractionReportedBy
    • InfractionHistoryStatusTypes
    • InfractionResultTypes
    • InfractionSituationTypes
    • PixErrorCode
    • PaymentFlowType
    • RefundsData
    • PixQueuedData
    • PixData
    • PixDataProperties
    • CashoutWebhookProperties
    • BilletPaymentRegisterResponse
    • BilletPaymentRegisterDetailResponse
    • Billets
    • BilletStatusType
    • BilletTermType
    • BilletDocumentType
    • BilletValueType
    • BilletProtestData
    • BilletAddicionalValueData
    • BilletReductionValueData
    • BilletPersonData
    • BilletStatusHistoryData
    • BilletPaymentData
    • BilletData
    • BilletPaymentRegisterData
    • BilletPaymentRegisterDataList
    • WebhookType
    • WebhookData
    • WebhookListData
    • MetaPagination
    • InternalTransferAccountType
    • InternalTransferStatus
    • InternalTransferRequest
    • InternalTransferResponse
    • ErrorRFC7807
  1. Authentication

Obter um token de acesso.

POST
/oauth/token
Authentication
A etapa inicial para utilizar a API corporativa é o processo de autenticação. Durante essa etapa, o servidor de autorização validará as credenciais do cliente e então emitirá um token.
A API da ONZ utiliza Bearer Tokens OAuth 2.0 para autenticação das requisições. Toda requisição à API exige a inclusão de um bearer token. Após obter o token de acesso, você pode utilizar qualquer um dos endpoints da API descritos abaixo (com base nos escopos concedidos à sua aplicação), incluindo o token de acesso no cabeçalho HTTP Authorization.
Escopos

Os escopos definem a extensão do acesso que um token possuirá em relação aos recursos da plataforma ONZ.
RecursoEscopo de leituraEscopo de escritaAcessível usando
Pixpix.readpix.writeToken corporativo
Billetsbillets.readbillets.writeToken corporativo
Webhookwebhook.readwebhook.writeToken corporativo
Transactionstransactions.readToken corporativo
Accountaccount.readToken corporativo
Infractionsinfractions.readinfractions.writeToken corporativo
Internal Transfersinternal-transfer.readinternal-transfer.writeToken corporativo

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201
application/json
Criado
Bodyapplication/json

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    "clientSecret": "string",
    "grantType": "client_credentials",
    "scope": "string"
}'
Response Response Example
201 - Exemplo 1
{
    "tokenType": "string",
    "expiresAt": 0,
    "refreshExpiresIn": 0,
    "notBeforePolicy": 0,
    "accessToken": "string",
    "scope": "string"
}
Próxima página
Obter transações da conta do cliente.
Built with