Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BoletoWebService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected http

http: Http

Protected options

options: BaseModelWebServiceOptions

Static Protected instance

instance: BoletoWebService

Methods

findOne

  • findOne(id: string): Promise<Boleto>

  • Find a Boleto by its ID

    Parameters

    • id: string

      the boleto ID

    Returns Promise<Boleto>

getPaymentInfo

  • getPaymentInfo(barcode: string): Promise<BoletoValidateResponse>

  • Retrieves data required for boleto payment using its barcode

    Parameters

    • barcode: string

      The boleto barcode

    Returns Promise<BoletoValidateResponse>

pay

  • pay(payload: BoletoPaymentRequestSchema): Promise<BoletoPaymentResponse>

  • Pays a boleto identified by his barcode using the account balance of the user whose id was sent in the request body

    Parameters

    • payload: BoletoPaymentRequestSchema

    Returns Promise<BoletoPaymentResponse>

Static getInstance

Static initialize

Generated using TypeDoc