Class OrderPaymentDetails

Hierarchy

OrderPaymentDetailsMinimal
- OrderPaymentDetails

Index

Constructors

constructor

new OrderPaymentDetails(reference: OrderReference, status: string, createdAt: ISODateTimeAsString, awaitingPaymentSince: Maybe<ISODateTimeAsString>, priceGuaranteedUntil: Maybe<ISODateTimeAsString>, executedAt: Maybe<ISODateTimeAsString>, canceledAt: Maybe<ISODateTimeAsString>, messageToSign: MessageToSign | undefined, paymentDetails: PaymentDetails | undefined, input: Inputs, output: Outputs, paymentReceivedAt: Maybe<ISODateTimeAsString>): OrderPaymentDetails

Overrides OrderPaymentDetailsMinimal.constructor
- Defined in src/models/order-payment-details.ts:12
Parameters
- reference: OrderReference
- status: string
- createdAt: ISODateTimeAsString
- awaitingPaymentSince: Maybe<ISODateTimeAsString>
- priceGuaranteedUntil: Maybe<ISODateTimeAsString>
- executedAt: Maybe<ISODateTimeAsString>
- canceledAt: Maybe<ISODateTimeAsString>
- messageToSign: MessageToSign | undefined
- paymentDetails: PaymentDetails | undefined
- input: Inputs
- output: Outputs
- paymentReceivedAt: Maybe<ISODateTimeAsString>
Returns OrderPaymentDetails

Properties

awaitingPaymentSince

awaitingPaymentSince: Maybe<ISODateTimeAsString>

canceledAt

canceledAt: Maybe<ISODateTimeAsString>

contactPerson

contactPerson: { email: Field<Email> }

Type declaration

email: Field<Email>

createdAt

createdAt: ISODateTimeAsString

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>

input

input: Inputs

messageToSign

messageToSign: MessageToSign | undefined

output

output: Outputs

Optional partnerFee

partnerFee: PartnerFee

paymentDetails

paymentDetails: PaymentDetails | undefined

paymentReceivedAt

paymentReceivedAt: Maybe<ISODateTimeAsString>

Optional priceBreakdown

priceBreakdown: PriceBreakdown

priceGuaranteedUntil

priceGuaranteedUntil: Maybe<ISODateTimeAsString>

reference

reference: OrderReference

status

status: string

Methods

areAllFieldsValid

areAllFieldsValid(): boolean

Inherited from OrderPaymentDetailsMinimal.areAllFieldsValid
- Defined in src/models/order.ts:230
Returns boolean

generateObjectForOrderCreation

generateObjectForOrderCreation(): Promise<any>

Inherited from OrderPaymentDetailsMinimal.generateObjectForOrderCreation
- Defined in src/models/order.ts:208
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

- Defined in src/models/order-payment-details.ts:50
Returns boolean

setContactEmail

setContactEmail(email: Email): Order

Inherited from OrderPaymentDetailsMinimal.setContactEmail
- Defined in src/models/order.ts:127
Parameters
- email: Email
Returns Order

setInput

setInput(currencyCode: CurrencyCode, amount: NumericalString): Order

Inherited from OrderPaymentDetailsMinimal.setInput
- Defined in src/models/order.ts:151
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

setOutput(currencyCode: CurrencyCode, amount: NumericalString): this

Inherited from OrderPaymentDetailsMinimal.setOutput
- Defined in src/models/order.ts:179
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

setPartnerFee

setPartnerFee(fee: PartnerFee): Order

Inherited from OrderPaymentDetailsMinimal.setPartnerFee
- Defined in src/models/order.ts:137
Parameters
- fee: PartnerFee
Returns Order

setPriceBreakdown

setPriceBreakdown(breakdown: PriceBreakdown): Order

Inherited from OrderPaymentDetailsMinimal.setPriceBreakdown
- Defined in src/models/order.ts:142
Parameters
- breakdown: PriceBreakdown
Returns Order

Static fromBookmarkModify

fromBookmarkModify(order: Order, direction: string, bookmark: BookmarkTypes): Order | never

Inherited from OrderPaymentDetailsMinimal.fromBookmarkModify
- Defined in src/models/order.ts:275
Parameters
- order: Order
- direction: string
- bookmark: BookmarkTypes
Returns Order | never

Static toBookmark

toBookmark(order: Order, direction: string, label: string): BookmarkTypes | never

Inherited from OrderPaymentDetailsMinimal.toBookmark
- Defined in src/models/order.ts:235
Parameters
- order: Order
- direction: string
- label: string
Returns BookmarkTypes | never

Generated using TypeDoc