Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrderPaymentDetailsMinimal

Represents an order returned from the Exchange API's /order/:uuid endpoint when the user has not authenticated themselves. This is to protect Bity users' privacy.

As you can see, the amount of data returned is significantly reduced compared to the full OrderPaymentDetails.

Orders go through this typical life-cycle:

  • createdAt
  • awaitingPaymentSince
  • paymentReceivedAt
  • executedAt

...and of course canceledAt can happen somewhere.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

awaitingPaymentSince

awaitingPaymentSince: Maybe<ISODateTimeAsString>

Since when the order has been waiting for a payment.

canceledAt

canceledAt: Maybe<ISODateTimeAsString>

When the order was cancelled.

contactPerson

contactPerson: { email: Field<Email> }

Type declaration

createdAt

createdAt: ISODateTimeAsString

When the order was created.

Optional directionToBasePriceOn

directionToBasePriceOn: DIRECTIONS

do

do: (a: (b: any) => void) => this

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: (b: any) => void): this

    • Parameters

      • a: (b: any) => void
          • (b: any): void

          • Parameters

            • b: any

            Returns void

      Returns this

executedAt

executedAt: Maybe<ISODateTimeAsString>

When the order was fulfilled.

input

input: Inputs

output

output: Outputs

Optional partnerFee

partnerFee: PartnerFee

paymentReceivedAt

paymentReceivedAt: Maybe<ISODateTimeAsString>

When the payment for the order was received.

Optional priceBreakdown

priceBreakdown: PriceBreakdown

priceGuaranteedUntil

priceGuaranteedUntil: Maybe<ISODateTimeAsString>

The order's price is guaranteed until this time.

reference

reference: OrderReference

A unique identifier for an order. Do not confuse this with PaymentDetailsBankAccount.bankReference! One is for tracking orders internally, the other is only for banks.

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.

setContactEmail

setInput

setOutput

setPartnerFee

setPriceBreakdown

Static fromBookmarkModify

Static toBookmark

Generated using TypeDoc