Payments

Create boleto

post/boletos/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/boletos/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

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

Request body

idinteger

paymentinteger required

Payment ID.

bill_idstring required

barcodestring required

qr_codestring required

pdfstring uri nullable

Signed URL to the rendered boleto PDF.

createdstring date-time

Response

Boleto created.

idinteger

paymentinteger required

Payment ID.

bill_idstring required

barcodestring required

qr_codestring required

pdfstring uri nullable

Signed URL to the rendered boleto PDF.

createdstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.