Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

awaitingPaymentSince

awaitingPaymentSince: string

canceledAt

canceledAt: string

contactPerson

contactPerson: object

Type declaration

createdAt

createdAt: string

Optional directionToBasePriceOn

directionToBasePriceOn: DIRECTIONS

do

do: function

Allows to stay within the context of configuring an order. By default it will be a no operation until setInput or setOutput is called.

Type declaration

    • (a: function): this
    • Parameters

      • a: function
          • (b: any): void
          • Parameters

            • b: any

            Returns void

      Returns this

executedAt

executedAt: string

input

input: Inputs

messageToSign

messageToSign: MessageToSign | undefined

output

output: Outputs

paymentDetails

paymentDetails: PaymentDetails | undefined

priceGuaranteedUntil

priceGuaranteedUntil: string

reference

reference: OrderReference

status

status: string

Methods

areAllFieldsValid

  • areAllFieldsValid(): boolean

generateObjectForOrderCreation

  • generateObjectForOrderCreation(): Promise<any>
  • Returns Promise<any>

    On resolve, an object (which is intentionally abstracted to be robust against API changes) that will be sent to Bity's /order endpoint. On rejection, the error object.

isSignatureRequired

  • isSignatureRequired(): boolean
  • Returns boolean

setContactEmail

setInput

  • Parameters

    • currencyCode: CurrencyCode

      A currency code supported by Bity. See /currencies endpoint for available codes.

    • amount: NumericalString

      A numerical string amount to retain precision, i.e. "14.3339".

    Returns Order

setOutput

  • Parameters

    • currencyCode: CurrencyCode

      A currency code supported by Bity. See /currencies endpoint for available codes.

    • amount: NumericalString

      A numerical string amount to retain precision, i.e. "14.3339".

    Returns this

Generated using TypeDoc