Interface: PaymentModule
payment/payment.module.PaymentModule
Implemented by
Table of contents
Properties
Methods
- observeDebitNotes
- observeInvoices
- createAllocation
- releaseAllocation
- amendAllocation
- getAllocation
- acceptInvoice
- rejectInvoice
- acceptDebitNote
- rejectDebitNote
- createInvoiceProcessor
- createAgreementPaymentProcess
- getPayerDetails
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
| Name | Type |
|---|---|
params | CreateAllocationParams |
Returns
Promise<Allocation>
Defined in
src/payment/payment.module.ts:50
releaseAllocation
▸ releaseAllocation(allocation): Promise<void>
Parameters
| Name | Type |
|---|---|
allocation | Allocation |
Returns
Promise<void>
Defined in
src/payment/payment.module.ts:52
amendAllocation
▸ amendAllocation(allocation, params): Promise<Allocation>
Parameters
| Name | Type |
|---|---|
allocation | Allocation |
params | CreateAllocationParams |
Returns
Promise<Allocation>
Defined in
src/payment/payment.module.ts:54
getAllocation
▸ getAllocation(id): Promise<Allocation>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<Allocation>
Defined in
src/payment/payment.module.ts:56
acceptInvoice
▸ acceptInvoice(invoice, allocation, amount): Promise<Invoice>
Parameters
| Name | Type |
|---|---|
invoice | Invoice |
allocation | Allocation |
amount | string |
Returns
Promise<Invoice>
Defined in
src/payment/payment.module.ts:58
rejectInvoice
▸ rejectInvoice(invoice, reason): Promise<Invoice>
Parameters
| Name | Type |
|---|---|
invoice | Invoice |
reason | string |
Returns
Promise<Invoice>
Defined in
src/payment/payment.module.ts:60
acceptDebitNote
▸ acceptDebitNote(debitNote, allocation, amount): Promise<DebitNote>
Parameters
| Name | Type |
|---|---|
debitNote | DebitNote |
allocation | Allocation |
amount | string |
Returns
Promise<DebitNote>
Defined in
src/payment/payment.module.ts:62
rejectDebitNote
▸ rejectDebitNote(debitNote, reason): Promise<DebitNote>
Parameters
| Name | Type |
|---|---|
debitNote | DebitNote |
reason | string |
Returns
Promise<DebitNote>
Defined in
src/payment/payment.module.ts:64
createInvoiceProcessor
▸ createInvoiceProcessor(): InvoiceProcessor
Returns
Defined in
src/payment/payment.module.ts:66
createAgreementPaymentProcess
▸ createAgreementPaymentProcess(agreement, allocation, options?): AgreementPaymentProcess
Parameters
| Name | Type |
|---|---|
agreement | Agreement |
allocation | Allocation |
options? | Partial<PaymentProcessOptions> |
Returns
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>