Download a boleto

Download the PDF of a boleto already issued for the charge.

GEThttps://api.raims.com/v1/charges/{id}/boleto

Get a temporary URL to download the charge's boleto that has already been issued. Call this endpoint with your API key and use the returned url to download the PDF from files.raims.com without sending the key in that download. The lookup does not request another issuance.

The boleto is used to collect payment and does not prove payment. For the document of a confirmed payment, use Download a payment receipt. Check the conditions in Boleto PDF.

Path Params

idstringrequired

The public ID of the charge whose boleto you want to download.

Up to 100 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request GET \
  --url https://api.raims.com/v1/charges/%7Bid%7D/boleto \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Download a boleto

Path Params

Responses

200OK

400Bad Request

404Not Found

409Conflict