TRtrytoku
Boleto

Anexar um PDF externo ao boleto

Changed on

Armazena o PDF do boleto gerado pela sua organização e dispara a mensageria ao pagador. O arquivo é guardado no mesmo lugar do PDF gerado pela Toku, então o portal e os endpoints de download passam a devolvê-lo sem nenhuma outra chamada. Disponível apenas para Accounts configuradas para enviar o seu próprio PDF.

post/brazil/boleto/onetime/external/upload-pdf

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/brazil/boleto/onetime/external/upload-pdf
  • Auth
    API key in header x-api-key

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

id_transactionstring required

Identificador da Transaction do boleto, devolvido na emissão.

notify_payerboolean

Quando false, o PDF é armazenado sem disparar a mensageria ao pagador.

pdf_urlstring uri required

URL https de onde a Toku baixa o PDF. Deve apontar para um endereço público.

Example request

{
  "id_transaction": "trs_TEST_RYA7FPaI_YTP65wwD8cFIJalsHR",
  "notify_payer": true,
  "pdf_url": "https://arquivos.suaempresa.com.br/faturas/29610614_11593437722.pdf"
}

Response

Successful Response

Changes