Documentação
  1. BANKING - CONTA DIGITAL
  2. Emissão de boletos (Banking)

Recarregar conta digital

Este endpoint permite a recarga da conta digital via boleto bancário.

🔼

POST {urlServidor}/v1/marketplace/billets/recharge

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Headers

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request POST \
--location '{urlServidor}/v1/marketplace/billets/recharge' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearer_token}}' \

Estrutura do Payload – Criar Boleto

NomeTipoObrigatórioDescrição
amountnumberSimValor total a recarregar

Body da requisição

O corpo da requisição deve ser enviado no formato JSON, conforme descrito abaixo:
amount Valor a ser depositado como saldo, sendo o mínimo permitido para o boleto é de dez reais.

{
  "amount": 1000
}

📤 Response — 200

A resposta retorna todas as informações do boleto gerado, incluindo dados de identificação, valores, status e links de pagamento.

{
    "_id": "6900fa1e735ea2ff0b814cdd",
    "type": "BILLET",
    "gateway_key": "c2334431-ebd2-464a-bd7c-8ef0b4480b4c",
    "establishment_id": "155085",
    "establishment": {
        "id": 155085,
        "first_name": "EC  Cobranças API",
        "last_name": null,
        "document": "10068114001",
        "account_number": "300543394162",
        "account_check_digit": "8"
    },
    "marketplace": {
        "id": 26,
        "nickname": "Parceiro Integrações",
        "first_name": "Webhooks Integrações",
        "last_name": "API Integrações",
        "document": "60274849000185"
    },
    "representative": {
        "id": 63,
        "first_name": "EC  Cobranças API",
        "last_name": null,
        "document": "10068114001"
    },
    "fees_banking": {
        "name": "Pacote de Tarifa Bancária Comercial",
        "description": "Pacote de Tarifa Bancária Comercial",
        "fees": 250
    },
    "amount": 1250,
    "original_amount": 1500,
    "barcode": null,
    "digitable_line": null,
    "url": null,
    "status": "PROCESSING",
    "expiration_at": "2025-10-31T12:00:00.000Z",
    "fees": 250,
    "billing_instructions": [],
    "recharge": true,
    "gateway_authorization": "CELCOIN",
    "request_origin": "API",
    "created_at": "2025-10-28T17:15:10.661Z",
    "updated_at": "2025-10-28T17:15:10.661Z",
    "__v": 0,
    "client": {
        "first_name": "EC  Cobranças API",
        "last_name": null,
        "document": "10068114001",
        "email": "[email protected]",
        "_id": "6900fa1e735ea2ff0b814cde"
    }
}

Descrição dos Campos do Response

CampoTipoDescrição
_idstringIdentificador único do boleto.
typestringTipo do boleto.
gateway_keystringChave gerada no gateway de pagamento.
establishment_idstringID do estabelecimento que solicitou a recarga.
descriptionstringDescrição informativa do boleto.
amountnumberValor bruto do boleto.
original_amountnumberValor líquido após taxas.
barcodestringCódigo de barras do boleto.
digitable_linestringLinha digitável do boleto.
urlstringLink para visualização ou download do boleto.
statusstringStatus atual do boleto. PROCESSING, CREATED, PENDING, CANCELED, PAID, FAILED
expiration_atstring (date-time)Data de vencimento do boleto.
payment_limit_datestring (date-time)Data limite para pagamento.
feesnumberValor total das taxas aplicadas.
fees_banking.namestringNome do plano tarifário aplicado.
fees_banking.descriptionstringDescrição do plano.
fees_banking.feesnumberValor cobrado na tarifa.
establishment.namestringNome/Razão social do estabelecimento.
establishment.descriptionstringDescrição interna do estabelecimento.
establishment.feesnumberValor de taxas aplicadas.
client.first_namestringNome ou razão social do cliente.
client.last_namestringSobrenome ou nome fantasia.
client.documentstringCPF ou CNPJ do cliente.
client.emailstringE-mail do cliente.
client.address.streetstringLogradouro.
client.address.numberstringNúmero do endereço.
client.address.complementstringComplemento.
client.address.neighborhoodstringBairro.
client.address.citystringCidade.
client.address.statestringEstado (UF).
client.address.zip_codestringCEP.
billet_instructions.bookletbooleanIndica se o boleto faz parte de um carnê.
billet_instructions.descriptionstringObservações do boleto.
billet_instructions.late_fee.modestringTipo de multa aplicada.
billet_instructions.late_fee.amountnumberValor percentual da multa.
billet_instructions.interest.modestringTipo de juros aplicados.
billet_instructions.interest.amountnumberValor percentual mensal do juros.
billet_instructions.discount.modestringTipo de desconto.
billet_instructions.discount.amountnumberPercentual de desconto.
billet_instructions.discount.limit_datestring (date-time)Data limite para aplicar o desconto.
rechargebooleanIndica se o boleto é de recarga.
pix_emvstringCódigo Pix copia e cola (opcional).

✅ Códigos de Resposta

CódigoDescrição
200Boleto criado com sucesso.
400Requisição malformada.
401Não autorizado.
422Erro de validação nos dados.
500Erro interno no servidor.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.

Updated about 1 month ago

Did this page help you?