Infopago API Docs
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-InAPI Contas - Cash-Out
  1. Cobranças
  • Manual Api Contas
    • Authentication
      • Obter token de acesso.
    • Contas BaaS
      • Listar contas do BaaS.
      • Consultar conta do BaaS.
    • Credenciais
      • Gerar credencial da API de Contas para conta filha.
      • Gerar credencial da API de QR Codes (Pix) para conta filha.
    • Onboardings
      • Criar onboarding no BaaS.
      • Enviar imagem do onboarding.
      • Listar onboardings do BaaS.
      • Consultar onboarding do BaaS.
    • Contas
      • Obter transações da conta do cliente.
      • Consultar detalhes de uma transação.
      • Consultar transações da conta.
      • Obter saldo da conta do cliente.
      • Consultar saldo da conta.
      • Consultar extrato consolidado por hora.
      • Consultar extrato consolidado da conta.
    • Chaves Pix
      • Listar chaves Pix da conta.
      • Criar chave Pix da conta.
      • Solicitar OTP para criar chave EMAIL ou PHONE.
      • Remover chave Pix da conta.
      • Consultar dados de uma chave Pix.
    • Pix
      • Iniciar pagamento Pix por QR Code.
      • Iniciar pagamento Pix por dados bancários.
      • Iniciar pagamento Pix por chave Pix.
      • Devolver um Pix recebido.
      • Consultar Pix por end-to-end-id.
      • Consultar Pix por chave de idempotência.
      • Obter comprovante Pix em PDF.
      • Consultar informações de QR Code Pix copia e cola
    • Estatísticas
      • Consultar estatísticas de pessoa
      • Consultar estatísticas de chave registrada
    • Boletos
      • Iniciar pagamento de boleto pela linha digitável.
      • Listar pagamentos de boletos.
      • Consultar pagamento de boleto por ID.
      • Iniciar pagamento de boleto pelo código do boleto.
      • Consultar informações de um boleto.
      • Consultar detalhes do pagamento de boleto por ID.
      • Obter comprovante de pagamento de boleto em PDF.
    • Infractions
      • Listar infrações abertas contra a conta.
      • Consultar infração por ID.
      • Enviar defesa para uma infração.
    • TED
      • Criar uma transferência TED.
      • Consultar TED por ID.
      • Consultar TED por chave de idempotência.
    • Pagadores
      • Criar pagador.
      • Listar pagadores.
      • Consultar pagador.
      • Atualizar pagador.
      • Excluir pagador.
    • Cobranças
      • Criar cobrança Pix, boleto ou híbrida.
        POST
      • Listar cobranças.
        GET
      • Consultar cobrança.
        GET
      • Cancelar cobrança.
        DELETE
      • Emitir cobrança em rascunho.
        POST
    • Webhooks
      • Listar webhooks cadastrados.
      • Consultar webhook.
      • Remover um webhook.
      • Criar webhook para operações de transferência.
      • Criar webhook para operações de recebimento.
      • Criar webhook para operações de devolução.
      • Criar webhook para falhas em operações de saída.
      • Criar webhook para cobranças (invoices).
      • Criar webhook para eventos CaaS (carteiras e ordens).
      • Criar webhook para operações de infração.
    • Internal Transfers
      • Criar transferência interna
      • Consultar transferência interna por EndToEndId
      • Consultar transferência interna por chave de idempotência
  • Esquemas
    • RequestBodies
      • WebhookData
      • AuthData
      • PixQrcData
      • PixManuData
      • PixDictData
      • BilletPaymentRegisterRequest
      • WebhookPayload
      • CashOutWebhookPayload
      • InfractionWebhookPayload
      • BilletData
      • BilletPaymentRequest
    • Token
    • creditDebitType
    • AccountType
    • IspbDenyList
    • Ispb
    • Issuer
    • AccountNumber
    • PixCashOutExpiration
    • RemittanceInformation
    • DebtorData
    • CreditorData
    • EndToEndId
    • IdempotencyKey
    • TxId
    • LocalInstrumentType
    • OperationStatus
    • PixErrorCode
    • PaymentFlowType
    • PixDataProperties
    • BilletPaymentRegisterResponse
    • BilletPaymentRegisterDetailResponse
    • BilletPaymentRegisterData
    • BilletPaymentRegisterDataList
    • WebhookType
    • MetaPagination
    • InternalTransferAccountType
    • InternalTransferStatus
    • InternalTransferRequest
    • InternalTransferResponse
    • ErrorRFC7807
    • Transactions
    • Balances
    • TransactionType
    • BaasAccountList
    • TransactionData
    • BaasAccountResponse
    • TransactionDetailsData
    • BaasAccount
    • BalanceData
    • BaasOnboardingList
    • MetaBalances
    • BaasOnboardingResponse
    • Statements
    • BaasOnboarding
    • StatementData
    • BaasOnboardingAddress
    • ConsolidatedStatements
    • BaasOnboardingPersonInput
    • ConsolidatedStatementData
    • BaasOnboardingCompanyInput
    • BaasOnboardingCreateNaturalPerson
    • InfractionListData
    • BaasOnboardingCreateLegalPerson
    • InfractionDetailBodyData
    • BaasOnboardingCreateResponse
    • InfractionDefenseHistoryData
    • BaasOnboardingImageUploadResponse
    • InfractionDefenseHistoryAttachmentsData
    • InfractionBodyData
    • InfractionData
    • InfractionStatus
    • InfractionTypes
    • InfractionReportedBy
    • InfractionHistoryStatusTypes
    • InfractionResultTypes
    • InfractionSituationTypes
    • RefundsData
    • PixQueuedData
    • PixData
    • CashoutWebhookProperties
    • Billets
    • BilletStatusType
    • BilletTermType
    • BilletDocumentType
    • BilletValueType
    • BilletProtestData
    • BilletAddicionalValueData
    • BilletReductionValueData
    • BilletPersonData
    • BilletStatusHistoryData
    • BilletPaymentData
    • BilletData
    • WebhookData
    • WebhookListData
    • ErrorInvoiceApi
    • InvoiceListMeta
    • InvoicePaymentMethod
    • InvoiceStatus
    • InvoiceType
    • InvoiceCustomerAddress
    • InvoiceCustomerRequest
    • InvoiceCustomer
    • InvoiceCustomerList
    • InvoiceInterest
    • InvoiceLateFee
    • InvoiceDiscount
    • InvoiceCreateRequest
    • Invoice
    • InvoiceListItem
    • InvoiceList
    • InvoiceSuccess
    • InvoiceWebhookNotification
    • CryptoWebhookNotification
    • PixKeyData
    • StatisticsInterval
    • SpiStatistics
    • FraudMarkersStatistics
    • InfractionReportsStatistics
    • PersonEntriesStatistics
    • KeyEntriesStatistics
    • PersonStatisticsBlock
    • KeyStatisticsBlock
    • GetPersonStatisticsResponse
    • GetEntryStatisticsResponse
    • AccountPixKey
    • AccountPixKeyCreateRequest
    • AccountPixKeyChallengeRequest
    • AccountPixKeyChallengeResponse
    • AccountPixKeysListResponse
    • PixRefundRequest
    • PixRefundResponse
    • TedRequest
    • TedResponse
    • BilletInfoRequest
    • BilletInfoResponse
    • EConsignadoCltLeadStatus
    • EConsignadoCltLead
    • EConsignadoCltLeadListRequest
    • EConsignadoCltLeadListResponse
    • EConsignadoProposalContact
    • EConsignadoRequestedGuarantee
    • EConsignadoCltLeadProposalRequest
    • EConsignadoCltLeadProposalItem
    • EConsignadoCltLeadProposalResponse
    • EConsignadoCltLeadOutcomeRequest
    • EConsignadoCltLeadOutcomeResponse
    • EConsignadoAuthorizationRequest
    • EConsignadoAuthorizationRequestResponse
    • EConsignadoAuthorizationStatusRequest
    • EConsignadoAuthorizationStatusResponse
    • EConsignadoFgtsBalanceRequest
    • EConsignadoFgtsBalanceResponse
    • BankarizationDecimal
    • BankarizationDebtor
    • BankarizationOperation
    • CreateAccountBankarizationApplication
    • BankarizationProductSummary
    • BankarizationProductDetail
    • BankarizationApplication
    • BankarizationApplicationList
    • CryptoRiskNetwork
    • CryptoRiskAnalyzeRequest
    • CryptoRiskAnalysisEvent
    • CryptoRiskAnalysis
    • CryptoRiskAnalysisSummary
    • CryptoRiskAnalysisEnvelope
    • CryptoRiskIngestProgress
    • CryptoRiskIngestAccepted
    • CryptoRiskIngestAcceptedEnvelope
    • CryptoRiskIngestProgressEnvelope
    • CryptoRiskAnalysisList
    • CryptoCaasNetwork
    • CryptoCaasAsset
    • CryptoCaasOperation
    • CryptoCaasOrderStatus
    • CryptoCaasWalletId
    • CryptoCaasDecimalAmount
    • CryptoCaasWalletCreateRequest
    • CryptoCaasQuoteCreateRequest
    • CryptoCaasFirstPurchaseAcknowledgment
    • CryptoCaasOrderCreateRequest
    • CryptoCaasWalletLimitSource
    • CryptoCaasWalletLimitReason
    • CryptoCaasWalletFirstPurchaseLimits
    • CryptoCaasWalletLimits
    • CryptoCaasWallet
    • CryptoCaasQuote
    • CryptoCaasOrder
    • CryptoCaasWalletEnvelope
    • CryptoCaasQuoteEnvelope
    • CryptoCaasOrderEnvelope
    • CryptoCaasWalletList
    • CryptoCaasOrderList
  1. Cobranças

Cancelar cobrança.

DELETE
/invoices/{invoiceId}
Cobranças
Cancela uma cobrança que ainda não foi liquidada.
Cobranças já pagas ou em situação que não admite cancelamento retornam erro de regra de negócio.

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:
invoices.write-Permite criar, alterar ou cancelar cobranças/faturas
or
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200
application/json
Cancelada
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠409
🟠422
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE '/invoices/' \
--header 'x-account-id;'
Response Response Example
200 - Exemplo 1
{
    "success": true
}
Página anterior
Consultar cobrança.
Próxima página
Emitir cobrança em rascunho.
Built with