Gerar boleto de recarga de conta

POST

/api/CashIn/Deposito

CashIn

Funcionalidade principal

O endpoint Deposito tem como objetivo gerar um título de cobrança registrado onde o titular da conta é o próprio pagador. Ao liquidar este boleto em qualquer instituição financeira, o valor é processado e creditado como saldo disponível na conta de pagamento do usuário no Pinbank.

Casos de uso comuns

Aporte de capital: O usuário deseja transferir recursos de uma conta em banco tradicional para sua conta digital Pinbank sem utilizar TED/Pix.

Conversão de espécie: O titular possui dinheiro em papel-moeda e utiliza o boleto para depositá-lo em sua conta através de uma casa lotérica ou caixa bancário.

Planejamento financeiro: Agendamento de aportes recorrentes para garantir saldo para contas futuras.

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

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/CashIn/Deposito' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "CodigoClienteLoja": 0,
        "CodigoCanalLoja": 0,
        "Token": "string",
        "Valor": 0,
        "IdTerminal": "string",
        "SerialNumber": "string",
        "VersaoTerminal": "string",
        "NsuTransacaoOrigem": "string",
        "DataHoraTransacaoOrigem": "string",
        "Mcc": "string"
    }
}'

Response Example

{
    "Data": {
        "NsuOperacao": 0,
        "ValorSaldo": 0,
        "ValorTarifa": 0
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:03:10

Página anterior

Consultar status dos documentos

Próxima página

Consultar saldo disponível na conta

Gerar boleto de recarga de conta

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns