JS API Reference

Interface: IPaymentApi

payment/api.IPaymentApi

Implemented by

Table of contents

Properties

Methods

Properties

receivedInvoices$

receivedInvoices$: Subject<Invoice>

Defined in

src/payment/api.ts:31


receivedDebitNotes$

receivedDebitNotes$: Subject<DebitNote>

Defined in

src/payment/api.ts:32

Methods

connect

connect(): Promise<void>

Starts the reader logic

Returns

Promise<void>

Defined in

src/payment/api.ts:35


getInvoice

getInvoice(id): Promise<Invoice>

Parameters

NameType
idstring

Returns

Promise<Invoice>

Defined in

src/payment/api.ts:37


acceptInvoice

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

Parameters

NameType
invoiceInvoice
allocationAllocation
amountstring

Returns

Promise<Invoice>

Defined in

src/payment/api.ts:39


rejectInvoice

rejectInvoice(invoice, reason): Promise<Invoice>

Parameters

NameType
invoiceInvoice
reasonstring

Returns

Promise<Invoice>

Defined in

src/payment/api.ts:41


getDebitNote

getDebitNote(id): Promise<DebitNote>

Parameters

NameType
idstring

Returns

Promise<DebitNote>

Defined in

src/payment/api.ts:43


acceptDebitNote

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

Parameters

NameType
debitNoteDebitNote
allocationAllocation
amountstring

Returns

Promise<DebitNote>

Defined in

src/payment/api.ts:45


rejectDebitNote

rejectDebitNote(debitNote, reason): Promise<DebitNote>

Parameters

NameType
debitNoteDebitNote
reasonstring

Returns

Promise<DebitNote>

Defined in

src/payment/api.ts:47


getAllocation

getAllocation(id): Promise<Allocation>

Parameters

NameType
idstring

Returns

Promise<Allocation>

Defined in

src/payment/api.ts:49


createAllocation

createAllocation(params): Promise<Allocation>

Parameters

NameType
paramsCreateAllocationParams

Returns

Promise<Allocation>

Defined in

src/payment/api.ts:51


releaseAllocation

releaseAllocation(allocation): Promise<void>

Parameters

NameType
allocationAllocation

Returns

Promise<void>

Defined in

src/payment/api.ts:53