@nevermined-io/payments
    Preparing search index...

    Interface CreateOrderOptions

    Body of POST /api/v1/orders (RegisterOrderDto). The authenticated merchant key sets the price; the seller's Stripe Connect account is resolved server-side and is deliberately NOT part of this contract.

    interface CreateOrderOptions {
        amountMinor: number;
        buyerRef?: string;
        captureMode?: "automatic";
        currency?: "usd";
        description?: string;
        idempotencyKey?: string;
        lineItems?: Record<string, unknown>[];
        metadata?: Record<string, unknown>;
        paymentProvider?: "stripe";
    }
    Index

    Properties

    amountMinor: number

    Charge amount in USD cents (at least 100, i.e. $1.00). The API validates the upper bound (BCK.ORDER.0001); a deployment may enforce a lower per-order cap (BCK.ORDER.0003).

    buyerRef?: string

    Opaque merchant-supplied buyer reference, e.g. the merchant's own order id (max 255 chars).

    captureMode?: "automatic"

    Stripe capture mode. Phase 1 supports 'automatic' only (the default).

    currency?: "usd"

    ISO currency, lower-cased. Phase 1 is USD-only; defaults to 'usd'.

    description?: string

    Human-readable description of the charge (max 1024 chars).

    idempotencyKey?: string

    Idempotency key (max 255 chars). A retry with the same key returns the original Order unchanged (and its clientSecret while the Order is still payable); the other fields of the retry are ignored, not merged. A retry with a different amountMinor or currency is refused with BCK.ORDER.0007.

    lineItems?: Record<string, unknown>[]

    Cart line items — merchant-defined structure, recorded verbatim (keys are not transformed), opaque to the API.

    metadata?: Record<string, unknown>

    Merchant-defined metadata, recorded verbatim (keys are not transformed), opaque to the API.

    paymentProvider?: "stripe"

    Payment Service Provider that settles the Order. Phase 1 implements 'stripe' only (the default).