Type alias OfferingDataBeta

OfferingData: {
    cancellation: CancelationDetails;
    description: string;
    payin: PayinDetails;
    payout: PayoutDetails;
    payoutUnitsPerPayinUnit: string;
    requiredClaims?: PresentationDefinitionV2;
}

An Offering is used by the PFI to describe a currency pair they have to offer including the requirements, conditions, and constraints in order to fulfill that offer.

Type declaration

  • cancellation: CancelationDetails

    Details about PFI's cancellation policy

  • description: string

    Brief description of what is being offered.

  • payin: PayinDetails

    Details about the currency that the PFI is buying in exchange for payout currency.

  • payout: PayoutDetails

    Details about the currency that the PFI is selling.

  • payoutUnitsPerPayinUnit: string

    Number of payout currency units for one payin currency unit (i.e 290000 USD for 1 BTC)

  • Optional requiredClaims?: PresentationDefinitionV2

    Articulates the claim(s) required when submitting an RFQ for this offering.