JS API Reference

Interface: PaymentModule

payment/payment.module.PaymentModule

Implemented by

Table of contents

Properties

Methods

Properties

events

events: EventEmitter<PaymentEvents, any>

Defined in

src/payment/payment.module.ts:44

Methods

observeDebitNotes

observeDebitNotes(): Observable<DebitNote>

Returns

Observable<DebitNote>

Defined in

src/payment/payment.module.ts:46


observeInvoices

observeInvoices(): Observable<Invoice>

Returns

Observable<Invoice>

Defined in

src/payment/payment.module.ts:48


createAllocation

createAllocation(params): Promise<Allocation>

Parameters

NameType
paramsCreateAllocationParams

Returns

Promise<Allocation>

Defined in

src/payment/payment.module.ts:50


releaseAllocation

releaseAllocation(allocation): Promise<void>

Parameters

NameType
allocationAllocation

Returns

Promise<void>

Defined in

src/payment/payment.module.ts:52


amendAllocation

amendAllocation(allocation, params): Promise<Allocation>

Parameters

NameType
allocationAllocation
paramsCreateAllocationParams

Returns

Promise<Allocation>

Defined in

src/payment/payment.module.ts:54


getAllocation

getAllocation(id): Promise<Allocation>

Parameters

NameType
idstring

Returns

Promise<Allocation>

Defined in

src/payment/payment.module.ts:56


acceptInvoice

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

Parameters

NameType
invoiceInvoice
allocationAllocation
amountstring

Returns

Promise<Invoice>

Defined in

src/payment/payment.module.ts:58


rejectInvoice

rejectInvoice(invoice, reason): Promise<Invoice>

Parameters

NameType
invoiceInvoice
reasonstring

Returns

Promise<Invoice>

Defined in

src/payment/payment.module.ts:60


acceptDebitNote

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

Parameters

NameType
debitNoteDebitNote
allocationAllocation
amountstring

Returns

Promise<DebitNote>

Defined in

src/payment/payment.module.ts:62


rejectDebitNote

rejectDebitNote(debitNote, reason): Promise<DebitNote>

Parameters

NameType
debitNoteDebitNote
reasonstring

Returns

Promise<DebitNote>

Defined in

src/payment/payment.module.ts:64


createInvoiceProcessor

createInvoiceProcessor(): InvoiceProcessor

Returns

InvoiceProcessor

Defined in

src/payment/payment.module.ts:66


createAgreementPaymentProcess

createAgreementPaymentProcess(agreement, allocation, options?): AgreementPaymentProcess

Parameters

NameType
agreementAgreement
allocationAllocation
options?Partial<PaymentProcessOptions>

Returns

AgreementPaymentProcess

Defined in

src/payment/payment.module.ts:68


getPayerDetails

getPayerDetails(): Promise<PayerDetails>

Get the payment platform and wallet address of the payer.

Returns

Promise<PayerDetails>

Defined in

src/payment/payment.module.ts:77