Interface: IPaymentApi
payment/api.IPaymentApi
Implemented by
Table of contents
Properties
Methods
- connect
- getInvoice
- acceptInvoice
- rejectInvoice
- getDebitNote
- acceptDebitNote
- rejectDebitNote
- getAllocation
- createAllocation
- releaseAllocation
Properties
receivedInvoices$
• receivedInvoices$: Subject<Invoice>
Defined in
receivedDebitNotes$
• receivedDebitNotes$: Subject<DebitNote>
Defined in
Methods
connect
▸ connect(): Promise<void>
Starts the reader logic
Returns
Promise<void>
Defined in
getInvoice
▸ getInvoice(id): Promise<Invoice>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<Invoice>
Defined in
acceptInvoice
▸ acceptInvoice(invoice, allocation, amount): Promise<Invoice>
Parameters
| Name | Type |
|---|---|
invoice | Invoice |
allocation | Allocation |
amount | string |
Returns
Promise<Invoice>
Defined in
rejectInvoice
▸ rejectInvoice(invoice, reason): Promise<Invoice>
Parameters
| Name | Type |
|---|---|
invoice | Invoice |
reason | string |
Returns
Promise<Invoice>
Defined in
getDebitNote
▸ getDebitNote(id): Promise<DebitNote>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<DebitNote>
Defined in
acceptDebitNote
▸ acceptDebitNote(debitNote, allocation, amount): Promise<DebitNote>
Parameters
| Name | Type |
|---|---|
debitNote | DebitNote |
allocation | Allocation |
amount | string |
Returns
Promise<DebitNote>
Defined in
rejectDebitNote
▸ rejectDebitNote(debitNote, reason): Promise<DebitNote>
Parameters
| Name | Type |
|---|---|
debitNote | DebitNote |
reason | string |
Returns
Promise<DebitNote>
Defined in
getAllocation
▸ getAllocation(id): Promise<Allocation>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<Allocation>
Defined in
createAllocation
▸ createAllocation(params): Promise<Allocation>
Parameters
| Name | Type |
|---|---|
params | CreateAllocationParams |
Returns
Promise<Allocation>
Defined in
releaseAllocation
▸ releaseAllocation(allocation): Promise<void>
Parameters
| Name | Type |
|---|---|
allocation | Allocation |
Returns
Promise<void>