Retrieve boleto

GET /boletos/{id}

Retrieve boleto

cURL

curl --request GET \
  --url https://api.piriod.com/boletos/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'

200

{
  "payment": 123,
  "bill_id": "<string>",
  "barcode": "<string>",
  "qr_code": "<string>",
  "id": 123,
  "pdf": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace · string · required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode · boolean · default: false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id · string · required

Resource identifier.

Response

200

application/json

The boleto.

Brazilian boleto bancário associated to a payment. Stores the bar code, bill ID and a PDF artifact.

payment · integer · required

Payment ID.

bill_id · string · required

Maximum string length: 128

barcode · string · required

qr_code · string · required

id · integer · read-only

pdf · string<uri> | null

Signed URL to the rendered boleto PDF.

created · string<date-time> · read-only