TRtrytoku
Boleto

Obter PDF do boleto

Changed on

Devolve em base64 o PDF dos boletos das Transactions indicadas.

post/brazil/boleto/onetime/download-pdf

Request

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

Request body

id_transactionsstring[] required

Response

PDF pronto, ou ainda em preparação quando status é pending.

base_64string nullable

Conteúdo do PDF em base64. Ausente enquanto o PDF não está pronto.

filenamestring nullable

Nome sugerido para o arquivo. Ausente enquanto o PDF não está pronto.

status'ready' | 'pending' required

Example response

{
  "filename": "boleto_transactions.pdf"
}

Changes

  • a6ef070075b1Revision changes
    • breaking

      request body became required

    • breaking

      the request property became required

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      response property base_64 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property filename list-of-types was widened by adding types null to media type application/json of response 200

    • info

      api operation id obter-pdf-do-boleto removed and replaced with download_pdf_for_transaction

    • info

      api tag Boleto added

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the required property to the response with the status