yajsapi - JavaScript high-level API
Yagna Contributor Guide

Class: Payment

yajsapi / Exports / rest/payment / Payment

Class: Payment

rest/payment.Payment

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Payment(cfg)

Parameters

Name

Type

cfg

Configuration

Defined in

yajsapi/rest/payment.ts:205

Properties

_api

Private _api: RequestorApi

Defined in

yajsapi/rest/payment.ts:205

Methods

accounts

accounts(): AsyncGenerator

Returns

AsyncGenerator

Defined in

yajsapi/rest/payment.ts:281

allocation

allocation(allocation_id): Promise<Allocation>

Parameters

Name

Type

allocation_id

string

Returns

Promise<Allocation>

Defined in

yajsapi/rest/payment.ts:260

allocations

allocations(): AsyncGenerator<Allocation, any, unknown>

Returns

AsyncGenerator<Allocation, any, unknown>

Defined in

yajsapi/rest/payment.ts:238

debit_note

debit_note(debit_note_id): Promise<DebitNote>

Parameters

Name

Type

debit_note_id

string

Returns

Promise<DebitNote>

Defined in

yajsapi/rest/payment.ts:295

decorate_demand

decorate_demand(ids): Promise

Parameters

Name

Type

ids

string[]

Returns

Promise

Defined in

yajsapi/rest/payment.ts:288

incoming_debit_notes

incoming_debit_notes(cancellationToken): AsyncGenerator<DebitNote, any, unknown>

Parameters

Name

Type

cancellationToken

any

Returns

AsyncGenerator<DebitNote, any, unknown>

Defined in

yajsapi/rest/payment.ts:359

incoming_invoices

incoming_invoices(cancellationToken): AsyncGenerator<Invoice, any, unknown>

Parameters

Name

Type

cancellationToken

any

Returns

AsyncGenerator<Invoice, any, unknown>

Defined in

yajsapi/rest/payment.ts:321

invoice

invoice(invoice_id): Promise<Invoice>

Parameters

Name

Type

invoice_id

string

Returns

Promise<Invoice>

Defined in

yajsapi/rest/payment.ts:313

invoices

invoices(): AsyncGenerator<Invoice, any, unknown>

Returns

AsyncGenerator<Invoice, any, unknown>

Defined in

yajsapi/rest/payment.ts:304

new_allocation

new_allocation(amount, payment_platform, payment_address, expires?, make_deposit?): ResourceCtx<Allocation>

Parameters

Name

Type

Default value

amount

number

undefined

payment_platform

string

undefined

payment_address

string

undefined

expires

null | Date

null

make_deposit

boolean

false

Returns

ResourceCtx<Allocation>

Defined in

yajsapi/rest/payment.ts:211