Liquidar boleto ou conta de consumo

POST

/api/CashOut/PagamentoConta

CashOut

Funcionalidade principal

Ele atua como o comando final de pagamento. Ele processa tanto a Linha Digitável (47 dígitos para boletos bancários ou 48 para convênios) quanto o Código de Barras bruto. O motor da API identifica automaticamente se o título é um boleto de cobrança, uma conta de concessionária (água, luz, gás) ou um tributo governamental.

Casos de uso comuns

Pagamento de contas do dia a dia: Permitir que o usuário final use o saldo da carteira para pagar faturas de luz, água, internet e telefone.

Liquidação de fornecedores: O ERP identifica que um boleto de compra de mercadoria está vencendo e utiliza a API para quitá-lo automaticamente usando o saldo da conta da empresa.

Recarga de saldo via boleto: Embora existam fluxos específicos, usuários podem pagar boletos de outras instituições para movimentar fundos entre contas usando o saldo atual.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/CashOut/PagamentoConta' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "CpfCnpj": "string",
        "Valor": 0,
        "Juros": 0,
        "Multa": 0,
        "Desconto": 0,
        "LinhaDigitavel": "string",
        "CpfCnpjBeneficiario": "string",
        "NomeBeneficiario": "string",
        "DataAgendamento": "string",
        "DataVencimento": "string",
        "XmlBoletoPagamentoOnlineBase64": "string",
        "TipoPagamento": 1
    }
}'

Response Example

{
    "Data": {
        "NsuPagamento": "string",
        "LinhaDigitavel": "string",
        "Status": "string",
        "CanalCorban": {
            "TipoPagto": "string",
            "Corban": "string"
        },
        "ValorBoletoLiquidado": 0,
        "ValorMoraLiquidado": 0,
        "ValorDescontoLiquidado": 0,
        "ValorMultaLiquidado": 0,
        "ValorFinalLiquidado": 0
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:26:56

Página anterior

Validar linha digitável de boleto (CIP)

Próxima página

Liquidar impostos e taxas governamentais

Liquidar boleto ou conta de consumo

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns