Infopago API Docs
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
  1. Webhooks
  • Manual Api Contas
    • Authentication
      • Obter um token de acesso.
    • 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.
        GET
      • Obter os dados de um webhook.
        GET
      • Remover um webhook.
        DELETE
      • Criar webhooks para operações de transferência.
        POST
      • Criar webhooks para operações de recebimento.
        POST
      • Criar webhooks para operações de devolução.
        POST
      • Criar webhooks para operações de cash-out.
        POST
      • Criar webhooks para operações de infração.
        POST
    • 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. Webhooks

Criar webhooks para operações de infração.

POST
/webhooks/infraction
Webhooks
Esses webhooks serão disparados quando uma infração for aberta na conta do cliente.

Callbacks

notification

Requisição

Authorization
OAuth 2.0
Client Credentials
Adicionar o parâmetro
Authorization
a Cabeçalhos
, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Token URL: /oauth/token
Scopes:
webhook.write-Access to create webhooks
or
Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201
application/json
Criado
Bodyapplication/json

🟠400
🟠401
🟠403
🟠409
🟠429
🔴500
🔴503
🔴504
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/webhooks/infraction' \
--header 'Content-Type: application/json' \
--data '{
    "uri": "http://example.com",
    "email": "string",
    "method": "POST",
    "enabled": true,
    "pauseOnFail": true,
    "headers": {
        "headerName": "string"
    }
}'
Response Response Example
201 - Exemplo de um webhook de devolução
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "INFRACTION",
    "uri": "https://example.com/webhook",
    "enabled": true
}
Página anterior
Criar webhooks para operações de cash-out.
Próxima página
Criar uma transferência interna
Built with