JS API Reference

Class: PaymentModuleImpl

payment/payment.module.PaymentModuleImpl

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new PaymentModuleImpl(deps, options?): PaymentModuleImpl

Parameters

NameType
depsGolemServices
options?PaymentModuleOptions

Returns

PaymentModuleImpl

Defined in

src/payment/payment.module.ts:97

Properties

events

events: EventEmitter<PaymentEvents, any>

Implementation of

PaymentModule.events

Defined in

src/payment/payment.module.ts:83

Methods

getPayerDetails

getPayerDetails(): Promise<PayerDetails>

Get the payment platform and wallet address of the payer.

Returns

Promise<PayerDetails>

Implementation of

PaymentModule.getPayerDetails

Defined in

src/payment/payment.module.ts:126


observeDebitNotes

observeDebitNotes(): Observable<DebitNote>

Returns

Observable<DebitNote>

Implementation of

PaymentModule.observeDebitNotes

Defined in

src/payment/payment.module.ts:132


observeInvoices

observeInvoices(): Observable<Invoice>

Returns

Observable<Invoice>

Implementation of

PaymentModule.observeInvoices

Defined in

src/payment/payment.module.ts:136


createAllocation

createAllocation(params): Promise<Allocation>

Parameters

NameType
paramsCreateAllocationParams

Returns

Promise<Allocation>

Implementation of

PaymentModule.createAllocation

Defined in

src/payment/payment.module.ts:140


releaseAllocation

releaseAllocation(allocation): Promise<void>

Parameters

NameType
allocationAllocation

Returns

Promise<void>

Implementation of

PaymentModule.releaseAllocation

Defined in

src/payment/payment.module.ts:162


getAllocation

getAllocation(id): Promise<Allocation>

Parameters

NameType
idstring

Returns

Promise<Allocation>

Implementation of

PaymentModule.getAllocation

Defined in

src/payment/payment.module.ts:190


amendAllocation

amendAllocation(allocation, _newOpts): Promise<Allocation>

Parameters

NameType
allocationAllocation
_newOptsCreateAllocationParams

Returns

Promise<Allocation>

Implementation of

PaymentModule.amendAllocation

Defined in

src/payment/payment.module.ts:196


acceptInvoice

acceptInvoice(invoice, allocation, amount): Promise<Invoice>

Parameters

NameType
invoiceInvoice
allocationAllocation
amountstring

Returns

Promise<Invoice>

Implementation of

PaymentModule.acceptInvoice

Defined in

src/payment/payment.module.ts:207


rejectInvoice

rejectInvoice(invoice, reason): Promise<Invoice>

Parameters

NameType
invoiceInvoice
reasonstring

Returns

Promise<Invoice>

Implementation of

PaymentModule.rejectInvoice

Defined in

src/payment/payment.module.ts:235


acceptDebitNote

acceptDebitNote(debitNote, allocation, amount): Promise<DebitNote>

Parameters

NameType
debitNoteDebitNote
allocationAllocation
amountstring

Returns

Promise<DebitNote>

Implementation of

PaymentModule.acceptDebitNote

Defined in

src/payment/payment.module.ts:251


rejectDebitNote

rejectDebitNote(debitNote, reason): Promise<DebitNote>

Parameters

NameType
debitNoteDebitNote
reasonstring

Returns

Promise<DebitNote>

Implementation of

PaymentModule.rejectDebitNote

Defined in

src/payment/payment.module.ts:279


createInvoiceProcessor

createInvoiceProcessor(): InvoiceProcessor

Creates an instance of utility class InvoiceProcessor that deals with invoice related use-cases

Returns

InvoiceProcessor

Implementation of

PaymentModule.createInvoiceProcessor

Defined in

src/payment/payment.module.ts:300


createAgreementPaymentProcess

createAgreementPaymentProcess(agreement, allocation, options?): AgreementPaymentProcess

Parameters

NameType
agreementAgreement
allocationAllocation
options?Partial<PaymentProcessOptions>

Returns

AgreementPaymentProcess

Implementation of

PaymentModule.createAgreementPaymentProcess

Defined in

src/payment/payment.module.ts:304