@peable.to/shared-types 0.13.0 → 0.15.0

package/dist/types/event.d.ts

@@ -1,3 +1,5 @@
+import type { Account } from './account';
+import type { ApplicationFee, Balance, Payout } from './balance';
 import type { Charge } from './charge';
 import type { Coupon, Price, Product, PromotionCode } from './catalog';
 import type { Customer } from './customer';
@@ -44,8 +46,10 @@ export interface BillingObservation {
  * Refunds are not PaymentIntent statuses: `refund.created|updated|failed` carry
  * the Refund, and `charge.refunded` the Charge whose `amount_refunded` moved.
  * A dispute is the network's process beside a payment that stays `succeeded`:
- * `charge.dispute.created` is a DEADLINE (evidence is due), `closed` carries
- * the outcome.
+ * `charge.dispute.created` is a DEADLINE (evidence is due), `updated` follows
+ * a staged or submitted response, `closed` carries the outcome, and
+ * `funds_withdrawn` / `funds_reinstated` the money's movement — never the
+ * evidence, which is not stored and so is never in an event.
  */
 export interface WebhookEventPayload {
     'payment_intent.created': PaymentIntent;
@@ -59,6 +63,10 @@ export interface WebhookEventPayload {
     'charge.dispute.created': Dispute;
     'charge.dispute.updated': Dispute;
     'charge.dispute.closed': Dispute;
+    /** The network took the disputed amount from the balance. */
+    'charge.dispute.funds_withdrawn': Dispute;
+    /** The network returned it (the dispute was won, or withdrawn by the cardholder). */
+    'charge.dispute.funds_reinstated': Dispute;
     'refund.created': Refund;
     'refund.updated': Refund;
     'refund.failed': Refund;
@@ -99,6 +107,23 @@ export interface WebhookEventPayload {
      * intent.
      */
     'connected_account.updated': ConnectedAccount;
+    /**
+     * The merchant's OWN fiat account changed (ADR 0015 §1) — readiness,
+     * requirements, settings. Emitted when a field the merchant acts on moved.
+     */
+    'account.updated': Account;
+    /** Orbit's fee was taken on a succeeded charge (ADR 0015 §3). */
+    'application_fee.created': ApplicationFee;
+    /** Part or all of a fee went back (a refund with `refund_application_fee`). */
+    'application_fee.refunded': ApplicationFee;
+    /** A payout of the merchant's account, mirrored from the provider (ADR 0015 §5). */
+    'payout.created': Payout;
+    'payout.updated': Payout;
+    'payout.paid': Payout;
+    'payout.failed': Payout;
+    'payout.canceled': Payout;
+    /** Funds became available in the account; carries the balance read from the ledger. */
+    'balance.available': Balance;
     'billing.observation.updated': BillingObservation;
     /**
      * A synthetic event sent to ONE endpoint when its owner asks to test it

package/dist/types/file.d.ts

@@ -0,0 +1,78 @@
+/**
+ * What a file is FOR. Decided at upload and never changed: the purpose is what
+ * sets the type and size policy, who may see the bytes, and which objects may
+ * reference the file — a `business_logo` is public, a `dispute_evidence` file
+ * is private and can only be attached to the merchant's own disputes.
+ */
+export declare const FILE_PURPOSES: readonly ["dispute_evidence", "business_logo", "identity_document", "additional_verification"];
+export type FilePurpose = (typeof FILE_PURPOSES)[number];
+/** The stored format, by its conventional extension (Stripe's `type`). */
+export declare const FILE_TYPES: readonly ["pdf", "png", "jpg"];
+export type FileType = (typeof FILE_TYPES)[number];
+/**
+ * Whether the bytes can be used right now.
+ *
+ *  - `available` — Oxy serves the file; it can be shown or forwarded.
+ *  - `withheld` — the file still exists and is not being served (its owner
+ *    trashed it or made it private); it can come back.
+ *  - `removed` — Oxy said the file is gone for good (deleted, taken down, lost).
+ *    The object stays so whatever referenced it can say why it stopped working.
+ */
+export declare const FILE_STATUSES: readonly ["available", "withheld", "removed"];
+export type FileStatus = (typeof FILE_STATUSES)[number];
+/**
+ * The upload policy of each purpose: the formats it takes, recognised from the
+ * bytes and never from a client's `Content-Type`, and the largest file.
+ *
+ * The provider's own ceilings, restated where the upload is parsed, so a file
+ * the card network would refuse is refused at upload — not at the one-shot
+ * dispute submission it was meant for.
+ */
+export declare const FILE_PURPOSE_POLICIES: Readonly<Record<FilePurpose, {
+    readonly types: readonly FileType[];
+    readonly max_bytes: number;
+}>>;
+/**
+ * The API's `file` object. Named `FileObject` rather than `File` so it never
+ * shadows the DOM's `File` in a browser that imports both.
+ */
+export interface FileObject {
+    /** `file_…`. */
+    id: string;
+    object: 'file';
+    /** The mode of the merchant that uploaded it (ADR 0017). */
+    livemode: boolean;
+    purpose: FilePurpose;
+    /** The name it was uploaded with, if it had a printable one. */
+    filename: string | null;
+    /** Bytes. */
+    size: number;
+    type: FileType;
+    status: FileStatus;
+    /**
+     * A public URL for a `business_logo` that is `available` — what a payer
+     * surface renders. `null` for every other purpose: evidence and identity
+     * documents are never addressable by URL, and their bytes leave Peable only
+     * to the provider they are submitted to.
+     */
+    url: string | null;
+    created: number;
+}
+/**
+ * `POST /v1/files` — exactly one source:
+ *
+ *  - the bytes, as `multipart/form-data` with a `purpose` field and a `file`
+ *    part (the SDK's `files.create({ purpose, file })` builds it);
+ *  - `oxy_file`: as JSON, an Oxy file the caller already owns (their
+ *    application's, or an account they are or act for). Its ownership is
+ *    checked once, here, and never again.
+ */
+export interface CreateFileFromOxyParams {
+    purpose: FilePurpose;
+    /** Oxy file id. */
+    oxy_file: string;
+}
+/** `GET /v1/files`. */
+export interface ListFilesParams {
+    purpose?: FilePurpose;
+}

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-export { UNITS_PER_COIN, isBaseUnitString, type CurrencyCode, CURRENCY_CODES, CURRENCY_DECIMALS, decimalsFor, isCurrencyCode, } from './money';
+export { UNITS_PER_COIN, isBaseUnitString, type CurrencyCode, type FiatCurrencyCode, CURRENCY_CODES, CURRENCY_DECIMALS, FIAT_CURRENCY_CODES, decimalsFor, isCurrencyCode, } from './money';
 export type { NetworkType } from './network';
 export type { ExpandParams, List, ListParams, RangeQuery } from './list';
-export { type Address, type AddressParams, type CancelPaymentIntentParams, type CapturePaymentIntentParams, type ConfirmPaymentIntentParams, type CreatePaymentIntentParams, type PaymentIntent, type PaymentIntentCancellationReason, type PaymentIntentCaptureMethod, type PaymentIntentFaircoin, type PaymentIntentLastPaymentError, type PaymentIntentNextAction, type PaymentIntentRail, type PaymentIntentSetupFutureUsage, type PaymentIntentStatus, type PaymentMethodType, type Shipping, type ShippingParams, type UpdatePaymentIntentParams, CARD_ONLY_STATUSES, EXPIRABLE_STATUSES, MERCHANT_CANCELLATION_REASONS, PAYMENT_INTENT_CANCELLATION_REASONS, PAYMENT_INTENT_CAPTURE_METHODS, PAYMENT_INTENT_RAILS, PAYMENT_INTENT_SETUP_FUTURE_USAGES, PAYMENT_INTENT_STATUSES, TERMINAL_STATUSES, canExpire, canStillBePaid, isValidStatusTransition, } from './paymentIntent';
+export { type Address, type AddressParams, type CancelPaymentIntentParams, type CapturePaymentIntentParams, type ConfirmPaymentIntentParams, type CreatePaymentIntentParams, type PaymentIntent, type PaymentIntentCancellationReason, type PaymentIntentCaptureMethod, type PaymentIntentFaircoin, type PaymentIntentLastPaymentError, type PaymentIntentNextAction, type PaymentIntentRail, type PaymentIntentSetupFutureUsage, type PaymentIntentStatus, type PaymentIntentTransferData, type PaymentMethodType, type Shipping, type ShippingParams, type UpdatePaymentIntentParams, CARD_ONLY_STATUSES, EXPIRABLE_STATUSES, MERCHANT_CANCELLATION_REASONS, PAYMENT_INTENT_CANCELLATION_REASONS, PAYMENT_INTENT_CAPTURE_METHODS, PAYMENT_INTENT_RAILS, PAYMENT_INTENT_SETUP_FUTURE_USAGES, PAYMENT_INTENT_STATUSES, TERMINAL_STATUSES, canExpire, canStillBePaid, isValidStatusTransition, } from './paymentIntent';
 export type { CardDetails, Charge, ChargeOutcome } from './charge';
 export type { CreateCustomerParams, Customer, DeletedCustomer, UpdateCustomerParams, } from './customer';
 export type { AttachPaymentMethodParams, BillingDetails, PaymentMethod, UpdatePaymentMethodParams, } from './paymentMethod';
@@ -9,8 +9,13 @@ export { type CancelSetupIntentParams, type CreateSetupIntentParams, type SetupI
 export { PEABLE_API_VERSION, type WebhookEventType, type WebhookEvent, type WebhookEventPayload, type WebhookEventRequest, type BillingObservation, } from './event';
 export { WEBHOOK_ENDPOINT_STATUSES, WEBHOOK_ENDPOINT_DISABLED_REASONS, WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT, WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS, type WebhookEnabledEvent, type WebhookEndpoint, type WebhookEndpointStatus, type WebhookEndpointDisabledReason, type DeletedWebhookEndpoint, type CreateWebhookEndpointParams, type UpdateWebhookEndpointParams, type RollWebhookEndpointSecretParams, } from './webhookEndpoint';
 export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERVALS, RECURRING_USAGE_TYPES, PRICE_TAX_BEHAVIORS, TRANSFORM_QUANTITY_ROUNDS, COUPON_DURATIONS, CATALOG_LIMITS, type PriceBillingScheme, type PriceTiersMode, type PriceType, type RecurringInterval, type RecurringUsageType, type PriceTaxBehavior, type TransformQuantityRound, type CouponDuration, type ProductMarketingFeature, type Product, type DeletedProduct, type PriceTier, type PriceTransformQuantity, type PriceRecurring, type Price, type Coupon, type DeletedCoupon, type PromotionCodeRestrictions, type PromotionCode, type RecurringParams, type PriceTierParams, type PriceDataParams, type DefaultPriceDataParams, type CreateProductParams, type UpdateProductParams, type ProductListParams, type CreatePriceParams, type UpdatePriceParams, type PriceListParams, type CreateCouponParams, type UpdateCouponParams, type CouponListParams, type CreatePromotionCodeParams, type UpdatePromotionCodeParams, type PromotionCodeListParams, } from './catalog';
-export type { Dispute, DisputeEvidence, DisputeStatus } from './dispute';
-export type { CapabilityStatus, ConnectedAccount, ConnectedAccountFaircoin, ConnectedAccountFaircoinStatus, ConnectedAccountRail, Refund, RefundOrigin, RefundStatus, Settlement, Transfer, TransferReversal, TransferReversalStatus, TransferStatus, TransferWithReversal, } from './settlement';
+export { DISPUTE_FILE_EVIDENCE_FIELDS, DISPUTE_REASONS, DISPUTE_TEXT_EVIDENCE_FIELDS, normalizeDisputeReason, type Dispute, type DisputeEvidence, type DisputeEvidenceDetails, type DisputeEvidenceField, type DisputeEvidenceParams, type DisputeFileEvidenceField, type DisputeReason, type DisputeStatus, type DisputeTextEvidenceField, type ListDisputesParams, type UpdateDisputeParams, } from './dispute';
+export { FILE_PURPOSES, FILE_PURPOSE_POLICIES, FILE_STATUSES, FILE_TYPES, type CreateFileFromOxyParams, type FileObject, type FilePurpose, type FileStatus, type FileType, type ListFilesParams, } from './file';
+export { CARD_RAIL_PAYMENT_METHOD_TYPES, PAYMENT_METHOD_CONFIGURATION_TYPES, PAYMENT_METHOD_CURRENCIES, type CardRailPaymentMethodType, type CreatePaymentMethodConfigurationParams, type CreatePaymentMethodDomainParams, type ListPaymentMethodDomainsParams, type PaymentMethodConfiguration, type PaymentMethodConfigurationEntry, type PaymentMethodConfigurationEntryParams, type PaymentMethodConfigurationType, type PaymentMethodDisplayPreference, type PaymentMethodDomain, type PaymentMethodDomainWalletStatus, type PaymentMethodUnavailableReason, type UpdatePaymentMethodConfigurationParams, type UpdatePaymentMethodDomainParams, } from './paymentMethodConfiguration';
+export { PAYOUT_INTERVALS, PAYOUT_WEEKLY_ANCHORS, type Account, type AccountBusinessProfile, type AccountCapabilityStatus, type AccountPayoutSchedule, type AccountRequirements, type AccountSettings, type AccountType, type CreateAccountLinkParams, type PayoutInterval, type PayoutWeeklyAnchor, type UpdateAccountParams, } from './account';
+export { BALANCE_TRANSACTION_STATUSES, BALANCE_TRANSACTION_TYPES, PAYOUT_STATUSES, RECONCILIATION_MISMATCH_KINDS, type ApplicationFee, type Balance, type BalanceAmount, type BalanceTransaction, type BalanceTransactionFeeDetail, type BalanceTransactionStatus, type BalanceTransactionType, type CreatePayoutParams, type FeeRefund, type ListBalanceTransactionsParams, type ListPayoutsParams, type Payout, type PayoutReconciliationReport, type PayoutStatus, type ReconciliationMismatch, type ReconciliationMismatchKind, } from './balance';
+export { REFUND_REASONS } from './settlement';
+export type { CapabilityStatus, ConnectedAccount, ConnectedAccountFaircoin, ConnectedAccountFaircoinStatus, ConnectedAccountRail, CreateRefundParams, Refund, RefundOrigin, RefundReason, RefundStatus, UpdateRefundParams, Settlement, Transfer, TransferReversal, TransferReversalStatus, TransferStatus, TransferWithReversal, } from './settlement';
 export type { WebhookDelivery, WebhookDeliveryStatus, } from './webhookDelivery';
 export { REQUEST_LOG_METHODS, REQUEST_LOG_RETENTION_DAYS, type RequestLog, type RequestLogListParams, type RequestLogMethod, type RequestLogStatusFilter, } from './requestLog';
 export { SIMULATED_FAIRCOIN_OUTCOMES, type SimulatedFaircoinOutcome, type SimulateFaircoinPaymentParams, } from './testHelpers';

package/dist/types/merchant.d.ts

@@ -35,6 +35,13 @@ export interface Merchant {
      * Absent again once Oxy reports the file deleted or taken down.
      */
     avatar_file_id?: string;
+    /**
+     * The wide wordmark payer surfaces show in their header: a `file_…` of
+     * purpose `business_logo`. Beside the avatar, never instead of it — the avatar
+     * is the square identity image (Stripe's branding `icon`), the logo is the
+     * wordmark (Stripe's branding `logo`). Absent when unset.
+     */
+    business_logo?: string;
     description?: string;
     created: number;
     updated_at: number;

package/dist/types/merchantDisplay.d.ts

@@ -3,5 +3,7 @@ export interface MerchantDisplay {
     name: string;
     /** Resolved server-side via the canonical media chokepoint; `null` when the merchant has no avatar. */
     avatar_url: string | null;
+    /** The merchant's `business_logo`, resolved; `null` when unset or not being served. */
+    logo_url: string | null;
     description: string | null;
 }

package/dist/types/money.d.ts

@@ -1,5 +1,9 @@
 /**
- * The currencies this gateway can denominate a payment in.
+ * The currencies this gateway can denominate a payment in: FairCoin on the
+ * chain rail, and on the card rail the fiat set the provider settles for the
+ * payment methods Orbit offers (cards, wallets, SEPA Debit, iDEAL, Bancontact,
+ * EPS). A local method narrows it further per payment
+ * (`PAYMENT_METHOD_CURRENCIES` in `paymentMethodConfiguration.ts`).
  *
  * A closed set, and the database mirrors it as a CHECK
  * (`db/schema/valueSets.ts`). ADR 0001 D4: the scale of an amount is a property
@@ -7,7 +11,7 @@
  * {@link CURRENCY_DECIMALS} exists and why {@link UNITS_PER_COIN} must never be
  * used to interpret a fiat amount.
  */
-export declare const CURRENCY_CODES: readonly ["FAIR", "EUR", "USD"];
+export declare const CURRENCY_CODES: readonly ["FAIR", "EUR", "USD", "GBP", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "CAD", "AUD", "JPY"];
 export type CurrencyCode = (typeof CURRENCY_CODES)[number];
 /** Whether an arbitrary string is a currency this gateway knows. */
 export declare function isCurrencyCode(value: string): value is CurrencyCode;
@@ -15,11 +19,15 @@ export declare function isCurrencyCode(value: string): value is CurrencyCode;
  * How many decimal places each currency's smallest unit represents — i.e. an
  * amount of `1` means `10^-decimals` of one whole unit.
  *
- * FairCoin's 8 is a consensus constant and is pinned against
+ * ISO 4217's minor units for every fiat member (JPY has none). FairCoin's 8 is a consensus constant and is pinned against
  * {@link UNITS_PER_COIN} by this package's own tests, so the two spellings of
  * one fact cannot drift.
  */
 export declare const CURRENCY_DECIMALS: Readonly<Record<CurrencyCode, number>>;
+/** A currency the card rail can denominate a payment in. */
+export type FiatCurrencyCode = Exclude<CurrencyCode, 'FAIR'>;
+/** The fiat members — every currency the card rail can denominate a payment in. */
+export declare const FIAT_CURRENCY_CODES: readonly FiatCurrencyCode[];
 /** The decimal places of `currency`'s smallest unit. */
 export declare function decimalsFor(currency: CurrencyCode): number;
 export declare const UNITS_PER_COIN = 100000000n;

package/dist/types/paymentIntent.d.ts

@@ -1,3 +1,4 @@
+import type { CardRailPaymentMethodType } from './paymentMethodConfiguration';
 import type { Charge } from './charge';
 import type { Customer } from './customer';
 import type { CurrencyCode } from './money';
@@ -85,8 +86,12 @@ export declare const PAYMENT_INTENT_CAPTURE_METHODS: readonly PaymentIntentCaptu
 /** Card only: keep the payment method on the customer for later (ADR 0016). */
 export type PaymentIntentSetupFutureUsage = 'on_session' | 'off_session';
 export declare const PAYMENT_INTENT_SETUP_FUTURE_USAGES: readonly PaymentIntentSetupFutureUsage[];
-/** The payment method types a rail accepts. One per rail today. */
-export type PaymentMethodType = 'card' | 'faircoin';
+/**
+ * The payment method types a PaymentIntent can carry: `faircoin` on the chain
+ * rail, and on the card rail the card and the local methods the provider
+ * collects in its hosted fields. Wallets (Apple Pay, Google Pay) are `card`.
+ */
+export type PaymentMethodType = 'faircoin' | CardRailPaymentMethodType;
 /** Why the last attempt failed. Peable's words, never the provider's raw prose. */
 export interface PaymentIntentLastPaymentError {
     /** `card_error` for a declined card; `payment_error` for a FairCoin underpayment. */
@@ -176,7 +181,16 @@ export interface PaymentIntent {
     status: PaymentIntentStatus;
     /** Which rail moves this payment. Decides which fields below are populated. */
     rail: PaymentIntentRail;
+    /**
+     * What the payer may pay with: `['faircoin']` on the chain; on the card rail
+     * the types named at creation, or those the configuration offers in this
+     * currency.
+     */
     payment_method_types: PaymentMethodType[];
+    /** The `pmc_…` whose methods this card payment offers; `null` on the chain and when types were named. */
+    payment_method_configuration_details: {
+        id: string;
+    } | null;
     /**
      * Amount in the currency's SMALLEST unit as a canonical integer string.
      * Never a float, and never interpretable without `currency`: m⊜ (10^-8 FAIR)
@@ -217,6 +231,21 @@ export interface PaymentIntent {
      * FairCoin only, and `faircoin.address` derives from that seller's own key.
      */
     connected_account: string | ConnectedAccount | null;
+    /**
+     * Orbit's fee on this card payment, taken by the provider from the
+     * destination account when the charge succeeds (ADR 0015 §3) — the
+     * INSTRUCTION; the fee actually taken is the `application_fee` object.
+     * `null` on a platform charge.
+     */
+    application_fee_amount: string | null;
+    /**
+     * A destination charge (ADR 0015 §2): the account (`ca_…`) the funds go to,
+     * and the amount transferred when the platform named one. `null` on a
+     * platform charge.
+     */
+    transfer_data: PaymentIntentTransferData | null;
+    /** The account (`ca_…`) that is the merchant of record, or `null` (the platform). */
+    on_behalf_of: string | null;
     client_secret: string;
     metadata: Record<string, string>;
     /** When an UNPAID intent expires. Meaningful only while `can_expire`. */
@@ -226,6 +255,13 @@ export interface PaymentIntent {
     created: number;
     updated_at: number;
 }
+/** Where a destination charge's funds go (`transfer_data`). */
+export interface PaymentIntentTransferData {
+    /** `ca_…` */
+    destination: string;
+    /** Base units transferred; `null` means the whole amount less `application_fee_amount`. */
+    amount: string | null;
+}
 /** `POST /v1/payment_intents`. */
 export interface CreatePaymentIntentParams {
     /** Amount in the currency's smallest unit, as a canonical integer string. */
@@ -236,8 +272,13 @@ export interface CreatePaymentIntentParams {
     network?: NetworkType;
     /** Defaults to `'FAIR'` on the faircoin rail; required on the card rail. */
     currency?: CurrencyCode;
-    /** Must name the rail's own type: `['card']` or `['faircoin']`. */
+    /**
+     * `['faircoin']` on the chain rail. On the card rail, any of the card-rail
+     * types the provider offers in `currency` — instead of a configuration.
+     */
     payment_method_types?: PaymentMethodType[];
+    /** Card only: the `pmc_…` whose methods to offer. Defaults to the merchant's default configuration. */
+    payment_method_configuration?: string;
     /** `cus_…`. */
     customer?: string;
     /** `pm_…`, card only. A saved payment method of `customer`. */
@@ -259,6 +300,19 @@ export interface CreatePaymentIntentParams {
     expires_in_seconds?: number;
     /** FairCoin only: pay this seller (`ca_…`, ADR 0012 D5). */
     connected_account?: string;
+    /**
+     * Card only, a platform acting for one of its connected accounts: Orbit's
+     * fee for this payment. Needs `transfer_data` (or `on_behalf_of`); refused
+     * beside `transfer_data.amount`.
+     */
+    application_fee_amount?: string;
+    /** Card only: a destination charge to one of the platform's connected accounts. */
+    transfer_data?: {
+        destination: string;
+        amount?: string;
+    };
+    /** Card only: make this connected account (`ca_…`) the merchant of record. */
+    on_behalf_of?: string;
     /** Card only, with `confirm`: where a redirect-based challenge returns. */
     return_url?: string;
 }

package/dist/types/paymentMethodConfiguration.d.ts

@@ -0,0 +1,116 @@
+import { type FiatCurrencyCode } from './money';
+/**
+ * The methods a configuration can turn on.
+ *
+ * `apple_pay` and `google_pay` are WALLETS over a card: a payment made with one
+ * is a `card` payment, so they appear here and never in a PaymentIntent's
+ * `payment_method_types`. `bizum` is listed because merchants ask for it and the
+ * honest answer is a reason, not an absence: the provider does not offer it.
+ *
+ * Deliberately absent: the provider's own consumer wallet (its brand on Orbit's
+ * checkout, `payment-provider-boundary.md`) and giropay (discontinued by the
+ * scheme).
+ */
+export declare const PAYMENT_METHOD_CONFIGURATION_TYPES: readonly ["card", "apple_pay", "google_pay", "sepa_debit", "ideal", "bancontact", "eps", "bizum"];
+export type PaymentMethodConfigurationType = (typeof PAYMENT_METHOD_CONFIGURATION_TYPES)[number];
+/** The card-rail types a PaymentIntent can carry in `payment_method_types`. */
+export declare const CARD_RAIL_PAYMENT_METHOD_TYPES: readonly ["card", "sepa_debit", "ideal", "bancontact", "eps"];
+export type CardRailPaymentMethodType = (typeof CARD_RAIL_PAYMENT_METHOD_TYPES)[number];
+/**
+ * Why a method cannot be offered whatever the merchant chooses.
+ *
+ *  - `provider_unsupported` — the processing provider does not offer it;
+ *  - `requires_card` — a wallet rides on card payments, and card is off.
+ */
+export type PaymentMethodUnavailableReason = 'provider_unsupported' | 'requires_card';
+/**
+ * The currencies each method can take a payment in. A method is offered on a
+ * payment only when its currency is listed — so iDEAL never appears on a USD
+ * payment, and a payer is never shown a method that would fail.
+ */
+export declare const PAYMENT_METHOD_CURRENCIES: Readonly<Record<PaymentMethodConfigurationType, readonly FiatCurrencyCode[]>>;
+/** The merchant's choice (`none`: Orbit's default) and what is in effect. */
+export interface PaymentMethodDisplayPreference {
+    preference: 'on' | 'off' | 'none';
+    value: 'on' | 'off';
+}
+export interface PaymentMethodConfigurationEntry {
+    /** Whether payers can be offered this method: it is on and nothing prevents it. */
+    available: boolean;
+    display_preference: PaymentMethodDisplayPreference;
+    /** Why it cannot be offered whatever the merchant chooses; `null` when it can. */
+    unavailable_reason: PaymentMethodUnavailableReason | null;
+    /** The payment currencies it is offered on. */
+    currencies: readonly FiatCurrencyCode[];
+}
+export type PaymentMethodConfiguration = {
+    /** `pmc_…`. */
+    id: string;
+    object: 'payment_method_configuration';
+    livemode: boolean;
+    name: string;
+    /** An inactive configuration cannot be named on a new PaymentIntent. The default is always active. */
+    active: boolean;
+    /** The configuration a PaymentIntent uses when it names none. Exactly one per merchant. */
+    is_default: boolean;
+    created: number;
+    updated_at: number;
+} & {
+    [K in PaymentMethodConfigurationType]: PaymentMethodConfigurationEntry;
+};
+/** One method's setting in a create or update. */
+export interface PaymentMethodConfigurationEntryParams {
+    display_preference: {
+        preference: 'on' | 'off' | 'none';
+    };
+}
+/** `POST /v1/payment_method_configurations`. */
+export type CreatePaymentMethodConfigurationParams = {
+    name?: string;
+} & {
+    [K in PaymentMethodConfigurationType]?: PaymentMethodConfigurationEntryParams;
+};
+/** `POST /v1/payment_method_configurations/:id`. */
+export type UpdatePaymentMethodConfigurationParams = CreatePaymentMethodConfigurationParams & {
+    active?: boolean;
+};
+/** A wallet's standing on one domain. */
+export interface PaymentMethodDomainWalletStatus {
+    /** `active`: the wallet can run on pages served from this domain. */
+    status: 'active' | 'inactive';
+    /** Present while `inactive`: what the wallet's verification said, in Peable's words. */
+    status_details: {
+        error_message: string;
+    } | null;
+}
+/**
+ * A web domain the merchant serves payment pages from (`pmd_…`), registered so
+ * Apple Pay and Google Pay run there. Peable's own hosted checkout needs none:
+ * its domain is Peable's.
+ */
+export interface PaymentMethodDomain {
+    id: string;
+    object: 'payment_method_domain';
+    livemode: boolean;
+    /** Lowercase hostname, no scheme, port or path. */
+    domain_name: string;
+    /** Whether wallets may run on it at all. */
+    enabled: boolean;
+    apple_pay: PaymentMethodDomainWalletStatus;
+    google_pay: PaymentMethodDomainWalletStatus;
+    created: number;
+}
+/** `POST /v1/payment_method_domains`. */
+export interface CreatePaymentMethodDomainParams {
+    domain_name: string;
+    enabled?: boolean;
+}
+/** `POST /v1/payment_method_domains/:id`. */
+export interface UpdatePaymentMethodDomainParams {
+    enabled?: boolean;
+}
+/** `GET /v1/payment_method_domains`. */
+export interface ListPaymentMethodDomainsParams {
+    domain_name?: string;
+    enabled?: boolean;
+}

package/dist/types/settlement.d.ts

@@ -1,3 +1,4 @@
+import type { AccountRequirements } from './account';
 import type { CurrencyCode } from './money';
 import type { NetworkType } from './network';
 import type { PaymentIntent } from './paymentIntent';
@@ -84,17 +85,12 @@ export interface ConnectedAccount {
     transfers_capability: CapabilityStatus | null;
     card_payments_capability: CapabilityStatus | null;
     /**
-     * COUNTS of outstanding requirements, never the requirements themselves and
-     * never their values. The gateway records that a seller owes a document; it
-     * does not learn what the document says.
+     * What the provider is waiting on — requirement IDENTIFIERS, never their
+     * values (the gateway records that a seller owes a document; it never learns
+     * what the document says) — and the provider's own `disabled_reason`. The
+     * same shape as `Account.requirements`.
      */
-    requirements: {
-        currently_due: number;
-        eventually_due: number;
-        past_due: number;
-        pending_verification: number;
-    };
-    disabled_reason_codes: readonly string[];
+    requirements: AccountRequirements;
     last_synced_at: number | null;
     created: number;
     updated_at: number;
@@ -203,8 +199,15 @@ export interface Settlement {
     /** Present only when a conversion happened. `null` is not a rate of 1. */
     exchange_rate: number | null;
 }
-/** Where one refund stands — the MONEY's own lifecycle, not the payment's. */
-export type RefundStatus = 'pending' | 'succeeded' | 'failed';
+/**
+ * Where one refund stands — the MONEY's own lifecycle, not the payment's.
+ * `canceled` only through `POST /v1/refunds/:id/cancel`, where the provider
+ * still allows it.
+ */
+export type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
+/** Stripe's refund reasons. */
+export declare const REFUND_REASONS: readonly ["duplicate", "fraudulent", "requested_by_customer"];
+export type RefundReason = (typeof REFUND_REASONS)[number];
 /**
  * Who created a refund.
  *
@@ -229,7 +232,31 @@ export interface Refund {
     amount: string;
     currency: CurrencyCode | string;
     status: RefundStatus;
+    reason: RefundReason | null;
     failure_code: string | null;
+    metadata: Record<string, string>;
     created: number;
     updated_at: number;
 }
+/** `POST /v1/refunds`. */
+export interface CreateRefundParams {
+    /** The `pi_…` being refunded. */
+    payment_intent: string;
+    /** YOUR id for this refund. The idempotency. */
+    external_ref: string;
+    /** Minor units, as a canonical integer string. Zero is refused. */
+    amount: string;
+    reason?: RefundReason;
+    metadata?: Record<string, string>;
+    /**
+     * Also refund Orbit's application fee, in proportion to the amount refunded
+     * (a payment that carried one: a destination charge, ADR 0015 §2).
+     */
+    refund_application_fee?: boolean;
+    /** Also reverse the transfer to the destination account, in proportion. */
+    reverse_transfer?: boolean;
+}
+/** `POST /v1/refunds/:id` — the merchant's own bookkeeping; `metadata` is a patch. */
+export interface UpdateRefundParams {
+    metadata?: Record<string, string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "Shared TypeScript types for the Peable Gateway — the wire contract shared by the backend, SDK, and frontend.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",