API publica

Core

create_static_pix

Gera um payload Pix estatico e retorna StaticPix.

parse_pix

Faz parse de um BR Code estatico e retorna StaticPix ou levanta erro especifico.

validate_pix

Valida um BR Code estatico e retorna ValidationResult, sem levantar excecao para erros de validacao do payload.

Modelos

• StaticPix
• ValidationResult
• ValidationError

QR

• QROptions
• QRStyle
• QRGradient
• QRLogo
• QRArtisticSource
• QRArtisticStyle

Erros

• PixError
• InvalidPixKeyError
• InvalidAmountError
• FieldTooLongError
• InvalidFieldError
• InvalidCRCError
• InvalidPayloadError
• MalformedPayloadError
• MissingOptionalDependencyError
• QRStyleError
• QRValidationError
• QRArtisticError

Note

Esta pagina e uma referencia manual. Geracao automatica via plugin de API pode ser adicionada depois que a API publica estabilizar.