Skip to main content

Crate delopay

Crate delopay 

Source
Expand description

Official Rust SDK for the DeloPay payments API.

DeloPay is a payment orchestrator: you create a payment, send the shopper to the hosted checkout, and confirm the result from a signed webhook. This crate wraps that REST API with typed, async methods, sensible retries, and a constant-time webhook verifier.

§Quick start

Requires the default client feature.

use delopay::{Delopay, PaymentCreateRequest};

// Use a secret key (`prd_...` for production, `snd_...` for sandbox).
let client = Delopay::new("prd_your_secret_key");

let payment = client
    .payments()
    .create(
        &PaymentCreateRequest::new(1999, "EUR") // 19.99 EUR, minor units
            .profile_id("pro_your_shop_id")
            .payment_link(true)
            .return_url("https://your-shop.example/return")
            .customer_email("ada@example.com"),
    )
    .await?;

// Redirect the shopper to the hosted checkout:
let url = client.hosted_checkout_url(&payment.merchant_id, &payment.payment_id);
println!("send shopper to {url}");

§Cargo features

  • client (default) — the async HTTP client: Delopay, the resources module, retries. Pulls in hyper, hyper-rustls and tokio.

With default-features = false the crate builds webhook verification and the wire models only, over a pure-Rust dependency tree that needs no C toolchain:

delopay = { version = "0.5", default-features = false }

§Webhooks

Verify the raw request body before trusting it — never parse the JSON first:

use delopay::webhooks;

let event = webhooks::verify(raw_body, sig_header, secret)?;
if event.event_type == "payment_succeeded" {
    if let Some(payment) = event.content.as_payment() {
        println!("fulfil order for {}", payment.payment_id);
    }
}

Re-exports§

pub use resources::api_keys::ApiKeyCreateRequest;client
pub use resources::api_keys::ApiKeyCreateResponse;client
pub use resources::api_keys::ApiKeyResponse;client
pub use resources::api_keys::ApiKeyRevokeResponse;client
pub use resources::api_keys::ApiKeyUpdateRequest;client
pub use resources::api_keys::ApiKeys;client
pub use resources::audit::Audit;client
pub use resources::audit::MerchantAuditLogListParams;client
pub use resources::authentication::Authentication;client
pub use resources::authentication::AuthenticationCreateRequest;client
pub use resources::availability_overrides::AvailabilityOverrideCreateRequest;client
pub use resources::availability_overrides::AvailabilityOverrides;client
pub use resources::availability_overrides::AvailabilityPreviewParams;client
pub use resources::availability_overrides::OverrideAction;client
pub use resources::availability_overrides::OverrideScope;client
pub use resources::billing::AllocationTransferRequest;client
pub use resources::billing::AutoRechargeUpdateRequest;client
pub use resources::billing::Billing;client
pub use resources::billing::BillingAllocations;client
pub use resources::billing::BillingCompleteSetupRequest;client
pub use resources::billing::BillingSetupRequest;client
pub use resources::billing::BlockedAttemptListParams;client
pub use resources::billing::LedgerListParams;client
pub use resources::billing::TopupRequest;client
pub use resources::buyer_account::BuyerAccount;client
pub use resources::buyer_account::BuyerAccountConfirmRequest;client
pub use resources::buyer_account::BuyerAccountPurchaseParams;client
pub use resources::buyer_account::BuyerAccountSectionParams;client
pub use resources::buyer_account::BuyerAccountSignInRequest;client
pub use resources::buyer_account::BuyerAccountVerifyCodeRequest;client
pub use resources::buyer_account::BuyerAccountVerifyLinkRequest;client
pub use resources::buyer_account::BuyerNoticeSettingsRequest;client
pub use resources::buyer_blocklist::BuyerBlocklist;client
pub use resources::buyer_blocklist::BuyerBlocklistEntryCreateRequest;client
pub use resources::buyer_blocklist::BuyerBlocklistEntryDeleteRequest;client
pub use resources::buyer_blocklist::BuyerBlocklistFromPaymentPreviewRequest;client
pub use resources::buyer_blocklist::BuyerBlocklistFromPaymentRequest;client
pub use resources::buyer_blocklist::BuyerBlocklistIpClass;client
pub use resources::buyer_blocklist::BuyerBlocklistKind;client
pub use resources::buyer_blocklist::BuyerBlocklistListParams;client
pub use resources::buyer_blocklist::BuyerBlocklistListScope;client
pub use resources::buyer_blocklist::BuyerBlocklistTraitAction;client
pub use resources::buyer_blocklist::PaymentBlockIdentifier;client
pub use resources::buyer_blocklist::PaymentBlockScope;client
pub use resources::buyer_blocklist::RadarEfwAction;client
pub use resources::buyer_blocklist::RadarReviewAction;client
pub use resources::buyer_blocklist::RadarSyncSettingsUpdateRequest;client
pub use resources::buyer_conversations::BuyerConversationAssignRequest;client
pub use resources::buyer_conversations::BuyerConversationListParams;client
pub use resources::buyer_conversations::BuyerConversationMessagesParams;client
pub use resources::buyer_conversations::BuyerConversationNoteRequest;client
pub use resources::buyer_conversations::BuyerConversationReplyRequest;client
pub use resources::buyer_conversations::BuyerConversationStartRequest;client
pub use resources::buyer_conversations::BuyerConversationStatusRequest;client
pub use resources::buyer_conversations::BuyerConversations;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceInformationRequest;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceNote;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceOutcome;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceQueueParams;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceReply;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceReviewCreate;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceReviews;client
pub use resources::buyer_evidence_reviews::BuyerEvidenceState;client
pub use resources::buyer_portal::BuyerAttachmentParams;client
pub use resources::buyer_portal::BuyerConversationParams;client
pub use resources::buyer_portal::BuyerEvidenceExtensionRequest;client
pub use resources::buyer_portal::BuyerEvidenceSubmitRequest;client
pub use resources::buyer_portal::BuyerFileUpload;client
pub use resources::buyer_portal::BuyerMessageCreateRequest;client
pub use resources::buyer_portal::BuyerPortal;client
pub use resources::buyer_portal::BuyerPortalContactEmailCommand;client
pub use resources::buyer_portal::BuyerPortalPageParams;client
pub use resources::buyer_portal::BuyerPortalPlanChangeRequest;client
pub use resources::buyer_portal::BuyerPortalProfileUpdateRequest;client
pub use resources::buyer_portal::BuyerPortalRefundRequestCreateRequest;client
pub use resources::buyer_portal::BuyerPortalSubscriptionActionRequest;client
pub use resources::buyer_portal::NativeEnrollmentRequest;client
pub use resources::chargeback_prevention::ChargebackPrevention;client
pub use resources::chargeback_prevention::PreventionCaseListParams;client
pub use resources::chargeback_prevention::PreventionRefundActionListParams;client
pub use resources::chargeback_prevention::PreventionRefundPreviewRequest;client
pub use resources::chargeback_prevention::PreventionRefundRuleSettings;client
pub use resources::checkout_methods::CheckoutAccountVisibilityRequest;client
pub use resources::checkout_methods::CheckoutEntriesUpdateRequest;client
pub use resources::checkout_methods::CheckoutEnvironment;client
pub use resources::checkout_methods::CheckoutMethods;client
pub use resources::checkout_methods::CheckoutMethodsAvailabilityParams;client
pub use resources::checkout_methods::CheckoutMethodsChildrenParams;client
pub use resources::checkout_methods::CheckoutMethodsUpdateRequest;client
pub use resources::checkout_methods::CheckoutRedirectRulesTestRequest;client
pub use resources::checkout_recovery::CandidatePreviewRequest;client
pub use resources::checkout_recovery::CheckoutRecovery;client
pub use resources::checkout_recovery::CheckoutReminderListParams;client
pub use resources::checkout_recovery::ManualEmailRequest;client
pub use resources::checkout_recovery::ReactivateCheckoutRequest;client
pub use resources::checkout_recovery::ReminderScenario;client
pub use resources::checkout_recovery::TestEmailRequest;client
pub use resources::checkout_templates::CheckoutTemplateApplyRequest;client
pub use resources::checkout_templates::CheckoutTemplateAssignRequest;client
pub use resources::checkout_templates::CheckoutTemplateCreateRequest;client
pub use resources::checkout_templates::CheckoutTemplateUpdateRequest;client
pub use resources::checkout_templates::CheckoutTemplates;client
pub use resources::connectors::AirwallexApplePayDomainsRegisterRequest;client
pub use resources::connectors::ConnectorBuyerMailUpdateRequest;client
pub use resources::connectors::ConnectorConsolidationRequest;client
pub use resources::connectors::ConnectorCreateRequest;client
pub use resources::connectors::ConnectorCreateWebhookAddress;client
pub use resources::connectors::ConnectorCurrencyPolicyUpdateRequest;client
pub use resources::connectors::ConnectorHealthParams;client
pub use resources::connectors::ConnectorShopUpdateRequest;client
pub use resources::connectors::ConnectorShopsAddRequest;client
pub use resources::connectors::ConnectorUpdateRequest;client
pub use resources::connectors::ConnectorWebhookRegisterRequest;client
pub use resources::connectors::Connectors;client
pub use resources::connectors::ProviderWebhookConfirmation;client
pub use resources::connectors::ProviderWebhookCreateRequest;client
pub use resources::connectors::ProviderWebhookDeleteRequest;client
pub use resources::connectors::ProviderWebhookReplaceRequest;client
pub use resources::connectors::ProviderWebhookUpdateRequest;client
pub use resources::connectors::StripePaymentMethodDomainsRegisterRequest;client
pub use resources::connectors::VaultRoutesApplyRequest;client
pub use resources::connectors::VaultRoutesPreviewRequest;client
pub use resources::connectors::VaultVerifyRequest;client
pub use resources::connectors::WebhookAddressRequest;client
pub use resources::connectors::WhopApplePayDomainsRegisterRequest;client
pub use resources::cost_rules::CostRules;client
pub use resources::cost_rules::CreateMerchantCostRuleRequest;client
pub use resources::cost_rules::UpdateMerchantCostRuleRequest;client
pub use resources::customers::BuyerInvoiceLinkRequest;client
pub use resources::customers::BuyerPortalLinkListParams;client
pub use resources::customers::CustomerCreateRequest;client
pub use resources::customers::CustomerIdentityHistoryRequest;client
pub use resources::customers::CustomerIdentityHistorySearchRequest;client
pub use resources::customers::CustomerIdentityImportPreviewRequest;client
pub use resources::customers::CustomerIdentityImportRequest;client
pub use resources::customers::CustomerIdentityImportRow;client
pub use resources::customers::CustomerListParams;client
pub use resources::customers::Customers;client
pub use resources::customers::MAX_IDENTITY_CUSTOMERS;client
pub use resources::customers::MAX_IDENTITY_HISTORY_REQUEST_BYTES;client
pub use resources::customers::MAX_IDENTITY_IMPORT_REQUEST_BYTES;client
pub use resources::customers::MAX_IDENTITY_IMPORT_ROWS;client
pub use resources::customers::MAX_IDENTITY_SEARCH_QUERY_CHARS;client
pub use resources::customers::MAX_IDENTITY_SEARCH_RESULTS;client
pub use resources::deployment_branding::BrandingAsset;client
pub use resources::deployment_branding::DeploymentBranding;client
pub use resources::deployment_branding::branding_asset_path;client
pub use resources::disputes::DisputeBulkAcceptRequest;client
pub use resources::disputes::DisputeBulkAction;client
pub use resources::disputes::DisputeBulkBlockBuyerRequest;client
pub use resources::disputes::DisputeBulkPreviewRequest;client
pub use resources::disputes::DisputeEvidenceRequest;client
pub use resources::disputes::DisputeListParams;client
pub use resources::disputes::DisputeReconcileRequest;client
pub use resources::disputes::DisputeRefundAssociationRequest;client
pub use resources::disputes::DisputeWorkspaceParams;client
pub use resources::disputes::DisputeWorkspaceSortBy;client
pub use resources::disputes::Disputes;client
pub use resources::disputes::SortDirection;client
pub use resources::ephemeral_keys::EphemeralKeys;client
pub use resources::events::EventListParams;client
pub use resources::events::EventManualTriggerRequest;client
pub use resources::events::Events;client
pub use resources::export::Export;client
pub use resources::export::ExportFormat;client
pub use resources::export::MAX_EXPORT_PRESENTATION_BYTES;client
pub use resources::external_records::ExternalRecordEnvironment;client
pub use resources::external_records::ExternalRecordRequest;client
pub use resources::external_records::ExternalRecordResource;client
pub use resources::external_records::ExternalRecords;client
pub use resources::fees::FeeScheduleCreateRequest;client
pub use resources::fees::FeeScheduleUpdateRequest;client
pub use resources::fees::FeeType;client
pub use resources::fees::Fees;client
pub use resources::identity_verifications::IdentityVerificationCreateRequest;client
pub use resources::identity_verifications::IdentityVerificationListParams;client
pub use resources::identity_verifications::IdentityVerifications;client
pub use resources::identity_verifications::VerificationKind;client
pub use resources::invoice_settings::InvoiceLogoRequest;client
pub use resources::invoice_settings::InvoicePreviewRequest;client
pub use resources::invoice_settings::InvoiceSettings;client
pub use resources::invoice_settings::InvoiceSettingsRequest;client
pub use resources::invoice_settings::InvoiceTaxRuleBuyer;client
pub use resources::invoice_settings::InvoiceTaxRuleEvaluateRequest;client
pub use resources::invoice_settings::InvoiceTaxRulesRequest;client
pub use resources::invoices::CreateCreditNoteRequest;client
pub use resources::invoices::CreateInvoiceRequest;client
pub use resources::invoices::CreditNoteLine;client
pub use resources::invoices::InvoiceBuyer;client
pub use resources::invoices::InvoiceExportFormat;client
pub use resources::invoices::InvoiceExportParams;client
pub use resources::invoices::InvoiceListParams;client
pub use resources::invoices::InvoicePageParams;client
pub use resources::invoices::InvoiceSourceRef;client
pub use resources::invoices::Invoices;client
pub use resources::invoices::UpdateInvoiceLine;client
pub use resources::invoices::UpdateInvoiceRequest;client
pub use resources::invoices::VoidInvoiceRequest;client
pub use resources::live::Live;client
pub use resources::live::LiveVersionsParams;client
pub use resources::mandates::Mandates;client
pub use resources::merchant_accounts::MerchantAccountCreateRequest;client
pub use resources::merchant_accounts::MerchantAccountUpdateRequest;client
pub use resources::merchant_accounts::MerchantAccounts;client
pub use resources::message_templates::MessageTemplateLanguageUpdateRequest;client
pub use resources::message_templates::MessageTemplatePreviewRequest;client
pub use resources::message_templates::MessageTemplates;client
pub use resources::message_templates::SendTestMessageRequest;client
pub use resources::operation_limits::OperationLimits;client
pub use resources::payment_links::PaymentLinkListParams;client
pub use resources::payment_methods::CardUpdate;client
pub use resources::payment_methods::CustomerPaymentMethodsListParams;client
pub use resources::payment_methods::PaymentMethodCreateRequest;client
pub use resources::payment_methods::PaymentMethodListParams;client
pub use resources::payment_methods::PaymentMethodPresentationParams;client
pub use resources::payment_methods::PaymentMethodUpdateRequest;client
pub use resources::payment_methods::PaymentMethods;client
pub use resources::payments::MAX_ABORT_REASON_CHARS;client
pub use resources::payments::OrderDetailsWithAmount;client
pub use resources::payments::PaymentAbortRequest;client
pub use resources::payments::PaymentAddonChoice;client
pub use resources::payments::PaymentCancelRequest;client
pub use resources::payments::PaymentCaptureRequest;client
pub use resources::payments::PaymentConfirmRequest;client
pub use resources::payments::PaymentCreateRequest;client
pub use resources::payments::PaymentListParams;client
pub use resources::payments::PaymentUpdateRequest;client
pub use resources::payments::Payments;client
pub use resources::payouts::PayoutCreateRequest;client
pub use resources::payouts::PayoutListParams;client
pub use resources::payouts::PayoutUpdateRequest;client
pub use resources::payouts::Payouts;client
pub use resources::paypal_disputes::PaypalDisputeActionRequest;client
pub use resources::paypal_disputes::PaypalDisputeImportRequest;client
pub use resources::paypal_disputes::PaypalDisputeListParams;client
pub use resources::paypal_disputes::PaypalDisputes;client
pub use resources::poll::Poll;client
pub use resources::processor_costs::BulkCreateProcessorCostSchedulesRequest;client
pub use resources::processor_costs::CreateProcessorCostScheduleRequest;client
pub use resources::processor_costs::ProcessorCosts;client
pub use resources::processor_costs::ReplaceProcessorCostScheduleRequest;client
pub use resources::processor_costs::UpdateProcessorCostScheduleRequest;client
pub use resources::processor_imports::ProcessorImports;client
pub use resources::processor_imports::PspImportCreateRequest;client
pub use resources::processor_imports::PspImportRecordType;client
pub use resources::products::AddonGroupCreateRequest;client
pub use resources::products::AddonGroupUpdateRequest;client
pub use resources::products::BundleDefinition;client
pub use resources::products::BundleItemRequest;client
pub use resources::products::ProductAliasCreateRequest;client
pub use resources::products::ProductCategoryCreateRequest;client
pub use resources::products::ProductCategoryListParams;client
pub use resources::products::ProductCategoryReorderRequest;client
pub use resources::products::ProductCategoryUpdateRequest;client
pub use resources::products::ProductConnectorReferenceCreateRequest;client
pub use resources::products::ProductCreateRequest;client
pub use resources::products::ProductDeleteRequest;client
pub use resources::products::ProductImportAcceptRequest;client
pub use resources::products::ProductImportApplyRequest;client
pub use resources::products::ProductImportArchivedAtProvider;client
pub use resources::products::ProductImportMixedDecision;client
pub use resources::products::ProductImportOptions;client
pub use resources::products::ProductImportPreviewRequest;client
pub use resources::products::ProductImportScope;client
pub use resources::products::ProductImportSuggestionsParams;client
pub use resources::products::ProductListParams;client
pub use resources::products::ProductPriceCreateRequest;client
pub use resources::products::ProductPriceUpdateRequest;client
pub use resources::products::ProductProviderCreateRequest;client
pub use resources::products::ProductProviderPushRequest;client
pub use resources::products::ProductProviderSyncBatchRequest;client
pub use resources::products::ProductResolveQuery;client
pub use resources::products::ProductSalesParams;client
pub use resources::products::ProductUpdateRequest;client
pub use resources::products::Products;client
pub use resources::products::ProviderArchiveRequest;client
pub use resources::profile_acquirers::ProfileAcquirerCreateRequest;client
pub use resources::profile_acquirers::ProfileAcquirerUpdateRequest;client
pub use resources::profile_acquirers::ProfileAcquirers;client
pub use resources::profiles::ProfileCreateRequest;client
pub use resources::profiles::ProfileUpdateRequest;client
pub use resources::profiles::Profiles;client
pub use resources::projects::ProjectCreateRequest;client
pub use resources::projects::ProjectUpdateRequest;client
pub use resources::projects::Projects;client
pub use resources::projects::StatsPeriod;client
pub use resources::refunds::BuyerRefundRequestApprove;client
pub use resources::refunds::BuyerRefundRequestDecline;client
pub use resources::refunds::BuyerRefundRequestListParams;client
pub use resources::refunds::BuyerRefundRequestStatus;client
pub use resources::refunds::RefundBulkBlockBuyerRequest;client
pub use resources::refunds::RefundBulkBlockPreviewRequest;client
pub use resources::refunds::RefundBulkExcludedIdentifier;client
pub use resources::refunds::RefundCreateRequest;client
pub use resources::refunds::RefundLineCreditRequest;client
pub use resources::refunds::RefundUpdateRequest;client
pub use resources::refunds::Refunds;client
pub use resources::regions::RegionCreateRequest;client
pub use resources::regions::RegionSetCountriesRequest;client
pub use resources::regions::RegionUpdateRequest;client
pub use resources::regions::Regions;client
pub use resources::relay::Relay;client
pub use resources::relay::RelayCaptureData;client
pub use resources::relay::RelayData;client
pub use resources::relay::RelayIncrementalAuthorizationData;client
pub use resources::relay::RelayRefundData;client
pub use resources::relay::RelayRequest;client
pub use resources::relay::RelayType;client
pub use resources::relay::RelayVoidData;client
pub use resources::risk::Risk;client
pub use resources::risk::RiskTuningTarget;client
pub use resources::risk::RiskTuningUpdateRequest;client
pub use resources::routing::CheckoutThemeConversionParams;client
pub use resources::routing::CheckoutThemeProgramRequest;client
pub use resources::routing::CheckoutThemeRules;client
pub use resources::routing::ConnectorCapOverrideRequest;client
pub use resources::routing::MethodSurcharge;client
pub use resources::routing::PerMethodSurchargeItem;client
pub use resources::routing::Routing;client
pub use resources::routing::RoutingActivatePayload;client
pub use resources::routing::RoutingConfigCreateRequest;client
pub use resources::routing::RoutingConnectorCapResetRequest;client
pub use resources::routing::RoutingConnectorCapScheduleShuffle;client
pub use resources::routing::RoutingDeactivateRequest;client
pub use resources::routing::SurchargeRuleRequest;client
pub use resources::routing::SurchargeRules;client
pub use resources::sell_to_restrictions::SellToRestrictionPolicyRequest;client
pub use resources::sell_to_restrictions::SellToRestrictions;client
pub use resources::settings::SettingChangeRequest;client
pub use resources::settings::Settings;client
pub use resources::settings::UpdateSettingsRequest;client
pub use resources::settlement::NativeSettlementFeeRefreshRequest;client
pub use resources::settlement::NativeSettlementListParams;client
pub use resources::settlement::NativeSettlementPayoutCreateRequest;client
pub use resources::settlement::NativeSettlementReportCreateRequest;client
pub use resources::settlement::ProcessorCostEventsParams;client
pub use resources::settlement::Settlement;client
pub use resources::settlement::SettlementBackfillRequest;client
pub use resources::settlement::SettlementCostParams;client
pub use resources::settlement::SettlementLineListParams;client
pub use resources::settlement::StatementAdjustmentCreateRequest;client
pub use resources::settlement::StatementAdvanceRecordRequest;client
pub use resources::settlement::StatementGenerateRequest;client
pub use resources::settlement::StatementListParams;client
pub use resources::settlement::StatementPayoutRecordRequest;client
pub use resources::settlement::StatementPayoutUpdateRequest;client
pub use resources::settlement::StatementPdfParams;client
pub use resources::shop_labels::ShopLabelCreateRequest;client
pub use resources::shop_labels::ShopLabelUpdateRequest;client
pub use resources::shop_labels::ShopLabels;client
pub use resources::shop_labels::ShopLabelsSetRequest;client
pub use resources::shops::GatewayConnectRequest;client
pub use resources::shops::ShopCreateRequest;client
pub use resources::shops::ShopGateways;client
pub use resources::shops::ShopUpdateRequest;client
pub use resources::shops::Shops;client
pub use resources::stripe_connect::StripeConnect;client
pub use resources::stripe_connect::StripeConnectAccountRequest;client
pub use resources::stripe_connect::StripeConnectLinkRequest;client
pub use resources::subscriptions::AdoptSubscriptionRequest;client
pub use resources::subscriptions::CancelSubscriptionRequest;client
pub use resources::subscriptions::ConfirmSubscriptionPaymentDetails;client
pub use resources::subscriptions::ConfirmSubscriptionRequest;client
pub use resources::subscriptions::CreateAndConfirmSubscriptionRequest;client
pub use resources::subscriptions::CreateSubscriptionPaymentDetails;client
pub use resources::subscriptions::CreateSubscriptionRequest;client
pub use resources::subscriptions::NativeDunningConfigRequest;client
pub use resources::subscriptions::NativeShopConfigRequest;client
pub use resources::subscriptions::PAYMENT_LOOKUP_MAX_IDS;client
pub use resources::subscriptions::PauseSubscriptionRequest;client
pub use resources::subscriptions::ResumeSubscriptionRequest;client
pub use resources::subscriptions::SubscriptionEstimateParams;client
pub use resources::subscriptions::SubscriptionImportApplyRequest;client
pub use resources::subscriptions::SubscriptionImportPreviewRequest;client
pub use resources::subscriptions::SubscriptionImportSelection;client
pub use resources::subscriptions::SubscriptionInvoiceListParams;client
pub use resources::subscriptions::SubscriptionItemsParams;client
pub use resources::subscriptions::SubscriptionListParams;client
pub use resources::subscriptions::SubscriptionPaymentDetails;client
pub use resources::subscriptions::SubscriptionSyncRequest;client
pub use resources::subscriptions::Subscriptions;client
pub use resources::subscriptions::UpdateSubscriptionRequest;client
pub use resources::three_ds_rules::ThreeDsRuleExecuteRequest;client
pub use resources::three_ds_rules::ThreeDsRules;client
pub use resources::users::ChangeMemberScopeRequest;client
pub use resources::users::ChangePasswordRequest;client
pub use resources::users::CreateInvitationLinkRequest;client
pub use resources::users::DashboardOAuthCompleteRequest;client
pub use resources::users::DashboardOAuthDisconnectRequest;client
pub use resources::users::DashboardOAuthLinkStartRequest;client
pub use resources::users::DashboardOAuthStartRequest;client
pub use resources::users::DeleteUserRoleRequest;client
pub use resources::users::ForgotPasswordRequest;client
pub use resources::users::InviteUsersRequest;client
pub use resources::users::ListRolesParams;client
pub use resources::users::ListUsersInLineageParams;client
pub use resources::users::LoginHistoryParams;client
pub use resources::users::PhoneOtpRequest;client
pub use resources::users::PhoneOtpVerifyRequest;client
pub use resources::users::ReInviteUserRequest;client
pub use resources::users::RegisterThroughInvitationLinkRequest;client
pub use resources::users::ResetPasswordRequest;client
pub use resources::users::ResetTeamMemberPasswordRequest;client
pub use resources::users::SetUserPreferenceRequest;client
pub use resources::users::SignInRequest;client
pub use resources::users::SignUpRequest;client
pub use resources::users::SignUpWithMerchantRequest;client
pub use resources::users::SwitchMerchantRequest;client
pub use resources::users::SwitchProfileRequest;client
pub use resources::users::UpdateDashboardTourRequest;client
pub use resources::users::UpdateInvitationLinkRequest;client
pub use resources::users::UpdateMemberExpiryRequest;client
pub use resources::users::UpdateMemberMethodAccessRequest;client
pub use resources::users::UpdateMemberPermissionOverridesRequest;client
pub use resources::users::UpdateRoleConnectorGrantRequest;client
pub use resources::users::UpdateTeamMemberContactsRequest;client
pub use resources::users::UpdateUserDetailsRequest;client
pub use resources::users::UpdateUserRoleRequest;client
pub use resources::users::Users;client
pub use resources::users::VerifyTotpRequest;client
pub use resources::users::WriteTeamMemberNoteRequest;client
pub use resources::verification::ApplePayVerificationRequest;client
pub use resources::verification::Verification;client
pub use resources::whop_resolution_cases::WhopResolutionCaseAction;client
pub use resources::whop_resolution_cases::WhopResolutionCaseActionRequest;client
pub use resources::whop_resolution_cases::WhopResolutionCaseEventsParams;client
pub use resources::whop_resolution_cases::WhopResolutionCaseListParams;client
pub use resources::whop_resolution_cases::WhopResolutionCaseLocator;client
pub use resources::whop_resolution_cases::WhopResolutionCaseStatus;client
pub use resources::whop_resolution_cases::WhopResolutionCases;client

Modules§

branding
Checkout branding: encode/decode the hosted checkout’s appearance configuration, plus the sanitizer for merchant-supplied custom CSS.
credentials
Typed API credentials — secret key, publishable key, client secret.
custom_fields
Merchant-defined checkout fields: the persistence codec, the conditional-visibility vocabulary and the rule evaluator.
money
Currency-aware amounts: money::Money and the ISO 4217 exponent table that stops a minor-unit integer being read in the wrong currency.
panes
Panes: the connector-metadata codec, the live capability catalogue and its frozen Stripe fallback, and the focused single-method checkout link.
resourcesclient
API resources. Each resource groups the operations for one object type.
types
Shared value types, re-exported for backwards compatibility.
webhooks
Webhook signature verification and event parsing. Webhook signature verification.

Structs§

ActiveRoutingAlgorithm
The active routing configuration wrapped in its { "algorithm": … } envelope, as merchant-account-based backends return it.
AddonGroupItemResponse
An add-on a group offers, with what it costs today.
AddonGroupResponse
A group of optional extras a product offers.
Address
A billing or shipping address: street details, phone, and email.
AddressDetails
Street-address details.
AdjustedRiskUnavailable
Why a connector has no adjusted assessment.
AdoptSubscriptionResponse
The result of taking a subscription already running at its billing processor into DeloPay.
AirwallexApplePayDomainResult
One URL’s outcome from registering Apple Pay domains on an Airwallex account.
AirwallexApplePayDomainsRegisterResponse
The per-URL outcomes of registering Apple Pay domains on an Airwallex account.
AllocationListResponse
Every shop allocation for a merchant.
AllocationResponse
A shop’s prepaid balance allocation, funded from the host merchant treasury.
AllocationTransferResponse
The result of moving funds between the host treasury and a shop allocation: both sides’ balances after the move, plus the ledger row.
AmlEvent
One change of a monitored subject’s AML result.
AmlEventListResponse
Every change of a monitored subject’s AML result, newest first.
AmlMonitoring
A verification subject’s ongoing AML monitoring.
AmountRange
A closed, inclusive band of order values in minor units.
ApiError
Structured detail of an API error. Boxed inside DelopayError so the success path of every Result stays small.
ArchivedShopResponse
An archived shop the caller may read.
AttemptVaultUsage
How a payment attempt’s card reached the processor: through a card vault, directly, or not recorded.
AuditChange
One line of an audited change.
AuditChangeItem
What one line of an audited change is about.
AuthResponse
The result of any call that establishes or re-establishes a session: sign-up, sign-in, OIDC sign-in, email verification, merchant / shop switching, invitation acceptance and recovery-code redemption.
AuthenticationResponse
A standalone 3-D Secure authentication as returned by the API.
AutoRechargeConfig
Auto-recharge configuration on a BillingProfileResponse.
AvailableCheckoutMethod
One item a shop may place in its checkout layout.
BillingAccountSummary
The shop’s billing processor account, as readiness was checked against it.
BillingProfileResponse
A merchant’s billing profile: prepaid balance, billing status and auto-recharge configuration.
BillingReadinessResponse
Which active recurring prices can start a subscription on the shop’s billing processor account.
BillingSetupResponse
The card-setup handshake: everything the frontend needs to render a Stripe card element and confirm the SetupIntent.
BlockedAttempt
A payment attempt rejected by the billing suspension gate before any payment was created.
BlockedAttemptListResponse
A page of blocked payment attempts.
BuiltInRegionGroupResponse
A built-in (global) region group such as EU / EEA / SEPA / LATAM / APAC.
BundleItemResponse
One component of a bundle.
BuyerAccountAvailability
Whether buyers can sign in on this platform, and how.
BuyerAccountConfirmation
A record confirmed for the signed-in buyer.
BuyerAccountInvoice
An issued invoice of a confirmed record.
BuyerAccountInvoiceList
One page of the confirmed records’ invoices, newest first.
BuyerAccountPortal
The shop’s customer portal, opened for a confirmed record.
BuyerAccountPurchase
One purchase, as a receipt.
BuyerAccountPurchasePage
One page of the buyer’s purchases, newest first.
BuyerAccountRefundRequest
A refund request of a confirmed record, with the shop’s decision.
BuyerAccountRefundRequestList
One page of the confirmed records’ refund requests, newest first.
BuyerAccountSession
A signed-in buyer. Send token as the api-key header of buyer account requests: build a separate client with it as the key.
BuyerAccountSessionInfo
The current session.
BuyerAccountShop
A shop the buyer has purchases at.
BuyerAccountShopList
The shops the buyer has purchases at.
BuyerAccountSignInResponse
What a started sign-in mailed.
BuyerAccountSubscription
One of the buyer’s subscriptions.
BuyerAccountSubscriptionList
One page of the buyer’s subscriptions, newest first.
BuyerBlocklistCapabilitiesResponse
Which classes of network an ip_class entry can be judged by.
BuyerBlocklistCardSource
The processor a blocked card fingerprint came from.
BuyerBlocklistEntryResponse
A buyer blocklist entry.
BuyerBlocklistEventResponse
One payment an entry refused or flagged.
BuyerBlocklistEventsResponse
An entry’s recorded refusals, newest first.
BuyerBlocklistFromPaymentPreviewResponse
The addresses an “all IPs” block of a payment’s buyer would take.
BuyerBlocklistIpCandidate
An address an “all IPs” block of a payment’s buyer would take.
BuyerBlocklistIpClassCapability
Whether one class of network can be judged now, and by what.
BuyerBlocklistIpClassFinding
A class of network a payment’s address belongs to.
BuyerBlocklistIpSnapshot
The addresses an “all IPs” block took.
BuyerBlocklistListResponse
One page of blocklist entries, newest first.
BuyerBlocklistRadarState
Where an entry stands with Stripe Radar.
BuyerCase
One refund request or dispute, where it stands and who acts next.
BuyerCaseEvent
One recorded step of a case.
BuyerCaseList
The buyer’s cases, newest first.
BuyerCaseRefund
The refund a case led to.
BuyerCaseRefundBalance
What of a payment can still be refunded.
BuyerCaseUpdate
A step of one of the buyer’s cases, shown in the conversation.
BuyerConversationAttachment
A file a message carries, or one uploaded for the next message.
BuyerConversationAttachmentRules
The shop’s rules for files on messages.
BuyerConversationCaseUpdate
A step of a case of the buyer at the shop, shown in the conversation.
BuyerConversationDetail
One conversation and its newest messages, oldest first.
BuyerConversationList
One page of the team’s inbox, the latest message first.
BuyerConversationMessage
One message, as the team sees it.
BuyerConversationNote
A team member’s internal note. The buyer never sees one.
BuyerConversationSummary
One conversation in the team’s inbox.
BuyerEvidence
A case’s evidence: what may be handed in and by when, the files saved and handed in, and what the reviewer said.
BuyerEvidenceDeadline
The buyer’s cut-off for evidence.
BuyerEvidenceEntry
One entry of a case’s evidence history.
BuyerEvidenceFile
A file uploaded for a case.
BuyerEvidencePolicy
The evidence policy that applied when the evidence was first opened.
BuyerEvidenceQueue
The shop’s cases with buyer evidence, the nearest target first.
BuyerEvidenceReviewDetail
One case with its evidence, history and files.
BuyerEvidenceReviewEntry
One step of the evidence’s history.
BuyerEvidenceReviewFile
A file of the evidence, as the review reads it.
BuyerEvidenceRules
What a submission may carry.
BuyerEvidenceSummary
A case with buyer evidence, as the review queue lists it.
BuyerInvoiceLink
A customer portal link, returned once when it is issued.
BuyerNoticeSettings
What the buyer is mailed about, at every shop.
BuyerPortalContactEmailDelivery
Where the messages of an email change stand.
BuyerPortalContactEmailOutcome
What became of an email change.
BuyerPortalConversation
One of the buyer’s conversations, as the buyer sees it.
BuyerPortalConversationList
The buyer’s conversations, the latest message first.
BuyerPortalInvoice
An issued invoice or credit note of the buyer’s.
BuyerPortalInvoiceLine
One line of an invoice.
BuyerPortalInvoicePage
One page of the buyer’s invoices.
BuyerPortalLinkPage
One page of a customer’s active portal links.
BuyerPortalLinkRestrictions
Restrictions on a portal link. A field left None imposes no ceiling; no field can grant what the shop’s current portal settings forbid.
BuyerPortalLinkSummary
An issued portal link, without its URL.
BuyerPortalMessage
One message, as the buyer sees it.
BuyerPortalMessagePage
The conversation with one shop and its newest messages, oldest first.
BuyerPortalPermissions
What a portal grant lets the buyer do.
BuyerPortalPlan
A plan the buyer can subscribe to or change to.
BuyerPortalPlanPage
One page of plans.
BuyerPortalProfile
The buyer’s contact and billing details, and what they may change.
BuyerPortalPurchase
One of the buyer’s purchases at the shop.
BuyerPortalPurchaseLine
One line of a purchase.
BuyerPortalPurchasePage
One page of the buyer’s purchases.
BuyerPortalRefundRequest
A refund request the buyer sent.
BuyerPortalRenewalRecovery
A failed renewal the buyer can still pay.
BuyerPortalSession
The portal session: the shop’s look and what the grant allows.
BuyerPortalSubscription
One of the buyer’s subscriptions at the shop.
BuyerPortalSubscriptionCapabilities
What the buyer may do with a subscription now.
BuyerPortalSubscriptionPage
One page of the buyer’s subscriptions.
BuyerPortalSubscriptionPermissions
Which subscription actions a portal grant allows, each independently.
BuyerRefundRequest
A buyer’s refund request.
BuyerRefundRequestList
One page of refund requests, newest first.
BuyerRiskEvaluation
One buyer risk evaluation: made at every confirm about to reach a processor.
BuyerRiskEvaluationsResponse
A payment’s buyer risk evaluations, newest first (at most 50). A payment never scored answers an empty list.
BuyerRiskReason
One signal that fired in a buyer risk evaluation.
CancelSubscriptionResponse
Returned by Subscriptions::cancel.
CandidatePreview
One checkout judged under a reminder rule.
CandidatePreviewResponse
The shop’s recent checkouts judged under a reminder rule. Nothing was sent.
ChangeMemberScopeResponse
A team member’s scope after a scope change.
CheckoutAccountVisibilityResponse
Where a connector account is hidden after a visibility change.
CheckoutBrandingResponse
The checkout-branding subset of a shop, as returned by both CheckoutBranding-gated routes: the read, and the write echoing back what it persisted.
CheckoutDataParamsclient
Query and locale of PaymentLinkSession::checkout_data.
CheckoutDataResponse
The hosted checkout’s bootstrap payload for a one-time payment, from GET /payment-link/data/{merchant_id}/{payment_id}.
CheckoutEntriesResponse
A shop’s checkout entries for one environment: separate ways into the hosted checkout of one payment (?entry=<key>), each in its own named look.
CheckoutEntry
One checkout entry. Read back from the API and sent again, unchanged or edited, in CheckoutEntriesUpdateRequest.
CheckoutEntryMethod
One thing a methods entry offers: a layout group, one provider’s method, or a general method by capability.
CheckoutLinkResolveResponse
The merchant and payment an opaque hosted checkout link opens.
CheckoutMethodAvailability
Whether one placeable item reaches the buyer asked about.
CheckoutMethodChildRef
One child of a placeable item, e.g. card_network:visa, method:ideal.
CheckoutMethodChildrenItem
What DeloPay confirms beneath one placeable item.
CheckoutMethodsAvailabilityResponse
For one buyer (country, amount, currency): which placeable items they are offered and every reason they are not.
CheckoutMethodsChildrenResponse
What DeloPay confirms beneath each item the shop can place: card networks, and the methods or coins a provider’s page offers.
CheckoutMethodsResetResponse
Answer of a checkout-methods reset: the stored layout of one environment was deleted.
CheckoutMethodsResponse
A shop’s checkout layout and every item it may place, for one environment.
CheckoutPaymentMethodOption
One method a payment can be limited to.
CheckoutPaymentMethodOptionsResponse
The methods a payment of the shop can be limited to through allowed_payment_method_types, in the order its checkout places them.
CheckoutRail
One rail the buyer can pick, from a vendor catalog.
CheckoutReactivation
The checkout a reactivation continues on.
CheckoutReactivationPreview
Whether a checkout can be reactivated now, and what it would continue.
CheckoutReactivationRecord
One earlier reactivation of a checkout.
CheckoutRecoveryStatus
A checkout’s recovery: whether and when the shop’s rule reminds it, every reason it does not, every message about it, and where its link goes.
CheckoutRedirectRulesTestResponse
What the tested redirect rules decide for the described buyer, and how each rule fared. Nothing is stored.
CheckoutReminder
One message to a buyer about a checkout: an automatic reminder or one sent by hand.
CheckoutReminderList
A page of messages to buyers, newest first.
CheckoutSessionclient
Buyer-side client for a single hosted-checkout payment, holding both browser-safe credentials — the merchant’s PublishableKey and the payment’s ClientSecret.
CheckoutSessionOptionsclient
Options shared by both buyer-side clients: which environment to talk to, and the usual transport knobs.
CheckoutTemplateApplyError
Why an apply failed in one shop.
CheckoutTemplateApplyResponse
What an assign or apply did, or would do on a dry run, in each shop.
CheckoutTemplateBlocker
Why a shop was left unchanged by an assign or apply.
CheckoutTemplateListResponse
The merchant’s checkout templates.
CheckoutTemplateOfShopResponse
The template a shop is on, if any.
CheckoutTemplateRef
A template by id and name.
CheckoutTemplateResponse
One checkout template and the shops on it.
CheckoutTemplateShop
One shop on a template, and whether it runs the template’s current settings.
CheckoutTemplateShopPlan
What an assign or apply did, or would do, in one shop.
CheckoutThemeConversionCell
One cell of a conversion report.
CheckoutThemeConversionComparison
A named variant measured against the shop default.
CheckoutThemeConversionFilters
The filters a conversion report applied.
CheckoutThemeConversionResponse
Rendered-to-paid checkout conversion, per appearance variant and segment.
CheckoutThemeProgramResponse
A stored checkout theme program: which of a shop’s appearance variants a buyer is shown.
ClientSecret
A payment’s client secret, from the checkout payload.
ConfirmSubscriptionResponse
Returned by the create-and-confirm and confirm subscription calls.
ConnectorBuyerMailResponse
A connected provider account’s optional buyer-email preference, for one credential environment.
ConnectorCapBand
One band of a weighted connector cap distribution.
ConnectorCapDistribution
How a ranged connector cap’s value is drawn, in the cap’s own unit.
ConnectorCapDrawnFrom
The range and distribution a cap’s current limit was drawn from.
ConnectorCapOverride
A connector account’s limits overridden for one project or shop.
ConnectorCapOverrideList
Every connector cap override of the merchant.
ConnectorCapOverrides
One connector account’s overrides, and the limits each shop it serves applies.
ConnectorCapShopLimit
The limits one shop applies to a connector account, and where they come from.
ConnectorCapability
One payment method’s state on the processor’s account.
ConnectorConsolidationResponse
What folding copies of one provider account into a connector does, or did.
ConnectorCurrencyCapability
What the provider is known to accept.
ConnectorCurrencyConversion
A connector account’s conversion setting, as read.
ConnectorCurrencyConversionSetting
A conversion setting: the currency a payment in a currency the connector does not take is converted to.
ConnectorCurrencyPolicyResponse
A connector account’s transaction-currency policy.
ConnectorCurrencyShopImpact
What a currency-policy write changes in one shop.
ConnectorHealthCheck
One probe behind a connector’s health verdict.
ConnectorHealthRequirements
What a processor is still waiting on before the account is fully enabled.
ConnectorHealthResponse
What a connector account’s own processor says about it.
ConnectorResponse
A merchant connector account as returned by the API.
ConnectorRisk
One connector’s stored risk in one shop.
ConnectorSellToEnforcement
Which buyer signals a connector account’s payments can be judged on.
ConnectorSellToRestriction
One connector account’s own policy.
ConnectorSettlementAttempt
One attempt’s settlement state on the rail that processed it.
ConnectorShopCurrencies
The currencies a connector account takes in one shop it serves.
ConnectorShopsResponse
The shops a connector account serves.
ConnectorWebhookEntry
One webhook endpoint registered with a connector.
ConnectorWebhookListResponse
The webhook endpoints registered for one connector.
ConnectorWebhookRegisterResponse
Result of registering a webhook endpoint with a connector.
ConnectorWebhookSyncResponse
The result of bringing a connector’s webhook subscriptions up to date.
ConnectorWebhookSyncResult
One endpoint’s outcome from Connectors::sync_webhook_events.
ConsolidationAccount
One account of a consolidation.
ConsolidationChanges
How many records a consolidation moved from a copy to the kept account.
ConsolidationConflict
A setting the accounts of a consolidation disagree on.
ConsolidationConflictValue
One value of a conflicting setting.
ConsolidationShop
One shop of a consolidated account.
CreateInvitationLinkResponse
A newly created team invitation link, with the secret to share.
CurrencyRevenue
Revenue taken in one currency. Amounts are in that currency’s minor units.
CustomerIdentityEntry
One value a customer has been known by, from one origin.
CustomerIdentityHistoryResponse
The history of the customers asked for, or a search’s matches.
CustomerIdentityImportPreviewResponse
What an import would do. Nothing was written.
CustomerIdentityImportResponse
An import run and its rows.
CustomerIdentityImportRowResult
One row’s result, in the order the rows were sent.
CustomerIdentityMatch
One customer’s matching values in a search answered by customer.
CustomerInfo
Inline customer details, used when creating a customer on-the-fly on a payment.
CustomerPaymentMethodsListResponse
A customer’s saved payment methods, as PaymentMethods::list_for_customer returns them.
CustomerResponse
A customer as returned by the API.
CustomerShopBulkPlacementResponse
Every distinct customer of a bulk placement, in the order of the request.
CustomerShopPlacementResponse
One customer’s placement in a shop.
DashboardOAuthProvidersResponse
The OAuth providers configured for dashboard sign-in, and the ones linked to the current account. Provider names are "google", "github" and "microsoft"; strings, so a new provider does not break deserialization.
DashboardOAuthStartResponse
Where to send the browser to start an OAuth sign-in or link.
DashboardTourAccess
The user’s current access, and the access they last acknowledged.
DashboardTourResponse
The user’s guided dashboard tour in the session’s scope.
DashboardTourScope
The scope a dashboard tour’s progress is kept for, taken from the session.
Delopayclient
The DeloPay API client.
DelopayBuilderclient
Builder for a Delopay client.
DeviceIntelligenceSettingResponse
Whether an account assesses its shop’s checkout devices.
DeviceSignalResponse
A payment’s device signal from its checkout’s device assessment.
DisputeBulkAcceptResponse
Every case’s result of a bulk accept.
DisputeBulkAcceptResult
One case’s result of a bulk accept.
DisputeBulkBlockBuyerResponse
Every case’s result of a bulk buyer block.
DisputeBulkBlockResult
One case’s result of a bulk buyer block.
DisputeBulkBlockedIdentifier
One buyer identifier a bulk block named, and what became of it.
DisputeBulkCase
A case a bulk action would act on.
DisputeBulkPreviewResponse
What a bulk action would do. Nothing was changed.
DisputeBulkSkip
A case a bulk action would leave out, and why.
DisputeBulkTotal
What the eligible cases add up to in one currency.
DisputeExportRecord
One row of a dispute export.
DisputeForeignCurrency
A dispute amount the processor reported in a foreign currency.
DisputeReconciliation
The settled amount of a foreign-currency dispute.
DisputeRefundAssociation
A refund declared against a dispute, or one the provider reported.
DisputeRefundAssociationsResponse
The refunds linked to a dispute. Empty means unknown, not “none”.
DisputeRefundDeclaration
A refund allocation declared against a dispute.
DisputeResponse
A dispute as returned by the API.
DisputeWorkspaceAggregate
Counts over the filtered workspace, without pagination.
DisputeWorkspaceExport
The complete filtered workspace, as one export.
DisputeWorkspaceFilters
The filter values present in the workspace’s scoped case set.
DisputeWorkspaceResponse
One page of the workspace.
DisputeWorkspaceRow
One case of the workspace: a native dispute or a case only the provider holds (a PayPal or Whop case, a subscription dispute).
EffectiveInvoiceSettings
The settings a shop’s next document is finalised with.
EpayoutsMethodsResponse
The e-Payouts rail catalog for one country.
EphemeralKeyResponse
A short-lived key granting a mobile or browser client temporary access to one customer’s data, as returned by EphemeralKeys::create and EphemeralKeys::delete.
EventDeliveryAttemptResponse
A delivery-attempt shape no route answers.
EventDetailResponse
One event with the request and response bodies of its delivery.
EventListResponse
A page of webhook events.
EventManualTriggerResponse
What a manual fire did, returned to the operator who fired it.
EventResponse
A webhook delivery event as returned by the API.
ExportEnvelope
A JSON export: the rows, how many there are, and the filters they were produced under.
ExternalRecordCapabilities
What this deployment accepts, per kind of object.
ExternalRecordCreateSupport
Whether an object with no record yet can be created by a record.
ExternalRecordKindCapability
What this deployment accepts for one kind of object.
ExternalRecordMarker
The marker of a refund, dispute or payment state that was recorded by hand rather than reported by the processor.
ExternalRecordResponse
A recorded out-of-band transition.
FeeScheduleResponse
A stored fee schedule, as returned by the fee-schedule endpoints.
FeeStatementDetail
A statement with its per-connector/currency breakdown.
FeeStatementSummary
One generated monthly settlement statement. Every *_usd amount is USD minor units.
GatewayResponse
A gateway (connector) connection on a shop.
GetUserRoleDetailsResponse
One role a team member holds, as listed by Users::list_user_roles.
HostingFeeTerm
What a host charged the shops it runs, with the evidence behind the figure.
IdentityVerificationFlow
A provider-side workflow an account can run.
IdentityVerificationFlowsResponse
The workflows an account can run in one environment.
IdentityVerificationListResponse
One page of verifications, newest first.
IdentityVerificationResponse
A verification.
InvitationLinkPreviewResponse
What a shared team invitation link offers, before joining.
InvitationLinkResponse
A team invitation link: its policy, usage and status.
InvitationLinkRestrictions
Who may join through a team invitation link: network ranges and a country rule ("allow" or "block") over ISO 3166-1 alpha-2 codes.
InviteLinkResponse
A pending member’s current invitation link, or why it is not shown.
InviteUsersResponse
The outcome of inviting one team member — one entry per invitee, in the order the invitations were sent.
InvoiceCreditNoteSummary
A credit note issued against an invoice.
InvoiceEmailDelivery
One message about a document to its buyer, its stored PDF attached, and what became of it.
InvoiceEmailDeliveryList
Every message about one document to its buyer, newest first.
InvoiceLine
One line of a document. Amounts are in minor units of the document’s currency.
InvoiceList
A page of documents.
InvoiceNoTaxReason
The document-level reason for showing no VAT.
InvoiceParty
The seller or the buyer on an invoice.
InvoiceProcessorTax
The order tax a tax service or the processor stated for the source.
InvoiceRefundSummary
What was refunded of a payment’s invoice, and how much of it is credited.
InvoiceSettingsResponse
Invoice settings: the merchant default, or one shop’s override of it.
InvoiceShareLink
A public link to an issued document’s stored PDF, valid for 7 days.
InvoiceTaxOutcome
What a line would be taxed at.
InvoiceTaxReporting
The document’s total tax converted into the reporting currency set in the invoice settings.
InvoiceTaxRule
One tax rule. A list is ordered; the first enabled rule whose conditions all match decides a line. An empty condition matches everything.
InvoiceTaxRuleEvaluation
The result of a tax-rule dry run. Nothing was written.
InvoiceTaxRules
A rule list: the merchant’s, or a shop’s.
InvoiceTaxWarning
Something about the document’s tax worth a look before finalising it.
IpCountryResolution
How this deployment resolves a buyer’s IP country.
JoinInvitationLinkPreAuthResponse
A join during sign-in, with the token for the next sign-in step.
JoinInvitationLinkResponse
The result of joining through a team invitation link.
LedgerEntry
One credit or debit against the prepaid balance.
LedgerResponse
A page of the balance ledger.
LifecycleWebhook
The subscription snapshot carried by a lifecycle webhook.
ListInvitationLinksResponse
The merchant’s team invitation links, newest first.
ListResponse
Generic paginated list envelope: { "data": [...], "size"?, "total_count"? }.
LiveActor
Who made a version.
LiveVersion
One kind of record’s version in one scope.
LiveVersionsResponse
The current version of each kind of record asked for.
LoginHistoryEntry
One row from the authenticated user’s login history.
LoginHistoryResponse
A page of the authenticated user’s login history.
ManagedWebhookState
The state of the platform’s own webhook at the provider.
MandateResponse
A mandate as returned by the API.
ManualEmailPreview
A message by hand as it would be sent now. Nothing was sent.
MemberMethodAccessResponse
Which checkout payment methods a member may change in the merchant.
MemberPermissionArea
One area of a member’s permissions: what their roles give, the level set for them, and what they have. Levels are "hidden", "read", "edit" or "write".
MemberPermissionOverridesResponse
A member’s permission overrides in the merchant.
MemberPermissionRole
A role a member holds, as the permission-overrides read lists it.
MerchantAccountResponse
A merchant account as returned by the API.
MerchantAuditActorInfo
Who acted, as a merchant is allowed to see it.
MerchantAuditLogEntry
One recorded change on a merchant’s account or one of its shops.
MerchantAuditLogExportRecord
One row of a merchant audit-log export.
MerchantAuditLogListResponse
One page of a merchant’s audit log.
MerchantAuditSessionInfo
The sign-in a change was made in.
MerchantAuditSettingChange
A change to one setting, as an audit entry records it.
MerchantCostRuleDeleteResponse
The answer to a cost rule delete.
MerchantCostRuleResponse
A recorded merchant cost rule.
MerchantInvoiceDocument
An invoice or credit note a merchant issues to a buyer. Amounts are in minor units of currency.
MerchantOverviewResponse
High-level merchant overview, as returned by the projects.overview endpoint.
MerchantOverviewStat
One headline figure on the merchant overview, with its period-over-period change.
MerchantRiskResponse
Every shop’s stored risk for the caller’s merchant.
MerchantRoutingAlgorithm
A full routing configuration, including the algorithm body.
MessageTemplateActor
Who last stored a text.
MessageTemplateDetail
One template, its variables and its text in every language.
MessageTemplateHtml
A text written as a whole HTML document.
MessageTemplateInherited
What applies without a text of the scope’s own.
MessageTemplateLanguage
One language of a template at one scope.
MessageTemplateLanguageSummary
Where one language of a template takes its text from.
MessageTemplateLayout
The parts of a text in the branded layout.
MessageTemplateList
Every template that can be edited at one scope.
MessageTemplatePreview
A template rendered with sample values.
MessageTemplateStored
A text stored at the requested scope.
MessageTemplateSummary
One template in a list.
MessageTemplateVariable
A variable a template’s text can use.
MethodAccessOption
A checkout payment method and its label.
MinimalRoleInfo
A role a member holds, as returned when listing the caller’s lineage.
Money
An amount in the minor units of a currency, carried together.
NativeDunningConfigResponse
The merchant-wide renewal recovery settings.
NativeEnrollmentAbandonResponse
Whether an unpaid enrollment was abandoned.
NativeEnrollmentResponse
Where a subscription enrollment from the portal stands: its first payment.
NativeSettlementAccountFees
Account-level fees a provider charges beside the per-transaction ones.
NativeSettlementFeeComponent
One component of a provider fee, as the provider itemised it.
NativeSettlementFeeEvidence
One piece of provider fee evidence behind a native calculation.
NativeSettlementFeeRefreshResponse
How far a bounded fee refresh got.
NativeSettlementFeeTerm
One fee term of a native calculation, with how far it can be trusted.
NativeSettlementPayout
One transfer recorded in the native-currency ledger.
NativeSettlementPayoutListResponse
A page of native-ledger transfers.
NativeSettlementPreview
A native settlement calculation: a period worked out in its transaction currency, with everything it rests on.
NativeSettlementReport
A frozen, immutable version of a native settlement calculation.
NativeSettlementReportListResponse
A page of report summaries.
NativeSettlementReportSummary
One report, without its per-transaction rows.
NativeSettlementSource
One transaction behind a native settlement calculation.
NativeSettlementTerms
The terms a native settlement calculation ran under. Sent to preview a period, and echoed back on every report so a saved figure carries the question it answered.
NativeSettlementTotals
The totals of a native settlement calculation, all in minor units of the calculation’s own currency.
NativeShopConfigResponse
A shop’s native enrollment settings, returned by Subscriptions::native_config and Subscriptions::update_native_config.
OperationLimitRule
One persisted operation-limit rule. Amounts are minor units of currency.
OperationLimitUsage
The caller’s own standing against the limit on one operation: the rule that applies to them and how much of its current window they have used. Computed with the same rule selection, window and usage records as enforcement, so the figure shown is the figure that blocks.
OperationScreeningResponse
A refund’s or payout’s transaction screening.
ParentGroupInfo
One entry in the caller’s permission listing: the role holds the listed scopes over the resources implied by name.
PauseSubscriptionResponse
Returned by Subscriptions::pause.
PaymentAbandonAttemptResponse
What abandoning an open attempt did.
PaymentAgentSignalResponse
What a payment’s checkout client was, for AI shopping agents. The hosted checkout’s render and the buyer’s confirm are both judged, and the strongest observation is kept.
PaymentAttemptResponse
A single attempt made on a payment, with its full failure detail. Returned in the data array of Payments::list_attempts — useful for surfacing retries across connectors (e.g. “attempt 1 stripe → insufficient_funds, attempt 2 adyen → success”).
PaymentBlockable
What of a payment’s buyer can be blocked.
PaymentClientContextEntry
One client/device observation captured while the buyer interacted with a payment.
PaymentClientContextListResponse
Every client/device observation recorded for one payment.
PaymentConnectorSettlementResponse
Every settlement line the caller may see for one payment.
PaymentDeviceTraits
The device traits a payment’s checkout reported.
PaymentDeviceTraitsSummary
A summary of a payment’s device traits.
PaymentEarlyFraudWarning
A Stripe early fraud warning on a payment.
PaymentFraudReview
A Stripe Radar review of a payment.
PaymentFraudSignalsResponse
Stripe’s fraud signals on a payment, and what of its buyer can be blocked.
PaymentHistoryActor
Who made a payment history event.
PaymentIdFormatConfig
Custom format for generated payment ids (cloaking), e.g. ORD-74219807.
PaymentIntegrationTestResponse
A payment’s integration-test mark after it was set.
PaymentIntentStateMetadata
State recorded on a payment beyond its status. Only the post-capture void is modeled; the rest arrives in extra.
PaymentLineRefunds
What refunds have credited to one product line, in minor units of the line’s currency.
PaymentLinkResponse
A hosted payment link as returned by the API.
PaymentLinkSessionclient
The client-secret half of a checkout: the /payment-link/* side channel.
PaymentLogConnectorCall
One request sent to the payment provider.
PaymentLogConnectorCallDetail
One provider request of a payment, with its masked request, response and error.
PaymentLogHeader
One recorded HTTP header.
PaymentLogIncomingWebhook
One webhook the payment provider sent.
PaymentLogIncomingWebhookDetail
One provider webhook of a payment, with its masked headers and body.
PaymentLogOutgoingAttempt
One delivery attempt of a shop webhook, as listed.
PaymentLogOutgoingDelivery
One delivery attempt of a shop webhook, with what was sent and answered.
PaymentLogOutgoingWebhook
One webhook sent to the shop, with every delivery attempt.
PaymentLogOutgoingWebhookDetail
Every delivery attempt of one shop webhook, with request and response.
PaymentLogsResponse
The traffic of a payment, oldest first, without payloads.
PaymentMethodAmountLimits
The order values a payment method is available for, so a checkout can re-evaluate its own tiles as the cart total changes instead of re-listing on every keystroke.
PaymentMethodDisplayInfo
Human-facing name and icon for a payment method type, so a custom checkout can render without maintaining a parallel name/logo table.
PaymentMethodListResponse
What PaymentMethods::list returns: the methods available for a payment, already filtered by country, order value and the merchant’s availability rules.
PaymentMethodPresentationEntry
One payment button, heading or group of a presentation.
PaymentMethodPresentationResponse
The shop’s payment buttons as the hosted checkout draws them, returned by PaymentMethods::presentation.
PaymentMethodResponse
A saved payment method as returned by the API.
PaymentPostSessionTokensResponse
The processor-side session a browser SDK completes.
PaymentProductLine
One frozen product line of a payment.
PaymentProductLineSummary
A payment’s first product line and how many it has, for list rows.
PaymentProductLines
A payment’s product names and prices, frozen when the payment was created.
PaymentReopenAttemptResponse
What reopening a switched-away attempt did: the attempt is the payment’s active one again, and redirect_url sends the buyer back to its provider session.
PaymentResponse
A payment intent as returned by the API.
PaymentRoutingDecision
How the connector of one attempt was chosen.
PaymentRoutingDecisionsResponse
How each attempt of a payment was routed.
PaymentScreeningResponse
A payment’s transaction screening.
PaymentScreeningSettingResponse
Whether an account screens its shop’s payments.
PaymentStatusHistoryEvent
One event on a payment’s status timeline: the creation of, or a status transition on, the payment intent or one of its attempts / refunds / disputes.
PaymentStatusHistoryResponse
The status timeline of a payment, returned by Payments::list_status_history.
PaymentsDeleteResponse
Outcome of soft-deleting a payment.
PayoutExportRecord
One row of a payout export.
PayoutResponse
A payout as returned by the API.
PaypalDisputeActionRecord
One action already taken on a case.
PaypalDisputeActionResponse
What a seller action did.
PaypalDisputeCase
One PayPal seller case.
PaypalDisputeDocument
A document attached to, or downloaded from, a case.
PaypalDisputeImportResponse
A page of cases imported from PayPal.
PeriodExpenseTerm
What the period cost the merchant outside the payment rails.
PermissionOverride
A permission level set for one area: area is a permission group such as "Operations", level one of "hidden", "read", "edit", "write".
PhoneDetails
A phone number split into national number + country code.
PhoneOtpResponse
The result of sending a one-time code to a phone number.
PhoneOtpVerifyResponse
The result of verifying a one-time code sent to a phone number.
PollStatusResponse
Status of an asynchronous operation, as returned by Poll::status.
PostCaptureVoidResponse
The state of a post-capture void.
PostSessionTokensRequestclient
Body of CheckoutSession::post_session_tokens, without the client secret the session attaches.
PresentationAction
What selecting a presentation entry does.
PresentationCachePolicy
How long a presentation may be reused. Also sent as Cache-Control.
PresentationChild
A descriptive badge of a presentation entry: a card network, a method or a crypto asset it contains.
PresentationContext
The buyer context a presentation was resolved for. A field left None was not applied.
PresentationCryptoNetwork
A crypto network a presentation child is offered on.
PresentationIcon
An entry’s or child’s artwork: one of the built-in glyphs (kind == "builtin", named by key) or an SVG document (kind == "svg", in data_uri).
PreventionAccount
One business account the provider holds under a connection.
PreventionAnswer
What DeloPay answered the provider’s latest delivery of an alert.
PreventionCase
One alert and what DeloPay knows of its payment.
PreventionCaseDetail
A case with its references and history.
PreventionCaseEvent
One state of a case DeloPay observed, in the provider’s order.
PreventionCaseList
A page of cases.
PreventionConnection
A connected provider account. Carries no key.
PreventionConnectionList
The merchant’s connections.
PreventionConnectionSummary
A connection’s state beside a case list.
PreventionRefundAction
What a refund rule did about one alert: a refund it made, or a payment it found already refunded. One per payment.
PreventionRefundActionList
A page of refund rule actions.
PreventionRefundActionSummary
The refund rule’s action on a case’s payment, as the case shows it.
PreventionRefundLimit
The most a refund rule refunds for one alert in one currency.
PreventionRefundPreview
What a rule would do with the account’s open alerts now.
PreventionRefundPreviewItem
What a rule would do with one open alert.
PreventionRefundRule
A merchant’s opt-in refund rule for one prevention connector account and environment. Off unless the merchant turns it on in the dashboard.
PreventionRefundRuleList
Every connected account’s refund rule.
PreventionSyncHealth
How current a connection’s cases are.
PriceBillingReadiness
One recurring price and whether it can start a subscription.
ProcessorCostBucket
A per-connector processor cost bucket, with a USD conversion.
ProcessorCostEstimateBasis
The fee schedule an estimated processor cost was priced from.
ProcessorCostEventBucket
Signed refund or dispute fees of one connector and currency.
ProcessorCostEventSource
One refund or dispute, with the rail’s own fee movements for it.
ProcessorCostEventTerm
Refund or dispute processor fees in one reporting period.
ProcessorCostEventsResponse
A page of refund and dispute cost evidence.
ProcessorCostMethodBucket
Payment fees grouped by the method recorded when each payment settled.
ProcessorCostNativeBucket
One bucket of processor cost in the rail’s own currency, keyed by connector, ownership, cost currency and cost exponent together.
ProcessorCostPeriodBucket
One (shop, connector, account, method, unit) bucket of a period’s rail costs. The unit is part of the key, so nothing here adds figures in different currencies.
ProcessorCostPeriodResponse
What a period’s payments cost at the rails, per shop, connector and method.
ProcessorCostScheduleResponse
A recorded processor cost schedule.
ProcessorFeeMovement
One fee movement the rail reported.
ProcessorVisibilityException
A processor a role’s payment-data policy singles out.
ProductAliasResponse
A name a product goes by.
ProductCategoryListResponse
The shop’s categories, in order.
ProductCategoryResponse
A shop category.
ProductConnectorReferenceResponse
A connected account’s product or price, tied to a catalogue product.
ProductDeleteResponse
What a delete with provider clean-up did.
ProductImageUploadResponse
An uploaded product image.
ProductImportCapabilities
What the import can and cannot read from a provider, so an unchanged verdict is read for what it covers.
ProductImportCounts
What an import preview found, or what an apply did.
ProductImportFailure
One item an import apply could not bring over.
ProductImportItemPreview
How one provider item relates to the catalogue.
ProductImportPreviewResponse
What a connected account’s catalogue holds, and how each item relates to the shop’s catalogue.
ProductImportPricePreview
How one provider price relates to the catalogue.
ProductImportRunListResponse
The shop’s past imports from one connected account, newest first.
ProductImportRunResponse
What one import did.
ProductListResponse
One page of a shop’s catalogue, newest first.
ProductPriceResponse
A price as the catalogue reports it.
ProductProviderCreateResponse
What a create at a provider did, or the plan it would carry out.
ProductProviderLink
The product’s copy at one connected account.
ProductProviderPushResponse
What a push to a provider did.
ProductProviderSyncBatchResponse
ProductProviderSyncResponse for several products.
ProductProviderSyncResponse
How a product compares with its copy at every account it is tied to.
ProductResolveResponse
The product a name or a connector’s id resolves to. Archived products resolve too, so a payment that references one is still attributed.
ProductResponse
A product as the catalogue reports it, prices and identity included.
ProductSalesByCurrency
A product’s sales in one currency and the refunds credited back to it.
ProductSalesResponse
What a product sold in a window, per currency.
ProfileAcquirerResponse
An acquirer identity a shop (business profile) presents for one card network: the acquirer BIN, the merchant ID the acquirer assigned, and the acquirer-reported fraud rate.
ProfileDefaultRoutingConfig
Per-profile default fallback routing.
ProfileLogoUploadResponse
Result of uploading a shop logo.
ProfileResponse
A shop (business profile) as returned by the API.
ProfitCostTerm
One merchant-side cost term (cost of goods, partner shares). amount_usd is a lower bound whenever incomplete or fx_incomplete is set; a gap is never a zero.
ProjectDirectStats
The figures of a project’s own shops, without its sub-projects.
ProjectLimitsResponse
How deep a merchant may nest projects, and how deep it does.
ProjectPathEntry
One project on the way from the top level to a project.
ProjectResponse
A project — an optional grouping layer that contains one or more shops.
ProjectSellToRestriction
One project’s own policy.
ProjectStats
Order and revenue figures for one project, plus its shops.
ProjectStatsResponse
Aggregate payment statistics across all of a merchant’s projects, as returned by the projects.stats endpoint.
ProviderAccount
A connected account of the shop the catalogue can work with.
ProviderAccountListResponse
The shop’s connected accounts the catalogue works with.
ProviderArchiveOutcome
What an archive did at one connected account.
ProviderCapabilities
What the catalogue can do with one connected account.
ProviderCleanup
A provider clean-up still to be carried out: one that failed, or one a delete recorded and never reached (attempted_at empty).
ProviderCleanupListResponse
Provider clean-ups still to be carried out.
ProviderCost
What a provider charged, or is estimated to charge.
ProviderCreatePlan
What a create writes at the provider.
ProviderCreatePrice
A catalogue price a create would carry to the provider.
ProviderCreatedPrice
One price of a create: the provider’s id, or why it was not created.
ProviderPriceTerms
A price’s terms as the catalogue or the provider states them.
ProviderPushStep
One provider write a push made.
ProviderSyncDifference
One difference between the catalogue and the provider.
ProviderUnsupportedPrice
A catalogue price the provider cannot hold, and why.
ProviderWebhookCapabilities
Which webhook changes a provider allows.
ProviderWebhookCreateResponse
A webhook created at the provider.
ProviderWebhookDeleteResult
What deleting one webhook at the provider did.
ProviderWebhookEndpoint
One webhook as the provider lists it.
ProviderWebhookListResponse
Every webhook the provider lists for a connector’s credentials in one environment.
ProviderWebhookReplacePreviewResponse
What replacing every webhook with the platform’s own would delete and keep. Nothing is changed.
ProviderWebhookReplaceResponse
What replacing every webhook with the platform’s own did.
PspImportAccount
A connector account an import can read.
PspImportCapability
What a connector account can provide for one record type.
PspImportCounts
How many records an import or one of its sources handled.
PspImportIssue
A record an import left out or could not record.
PspImportIssuesResponse
One page of an import’s issues.
PspImportLatestResponse
The newest import in an environment.
PspImportRunResponse
An import run.
PspImportSourceProgress
One connector account and record type of an import.
PspImportSourcesResponse
Every connector account an import can read in an environment.
PublicBranding
The deployment’s branding as every page may read it.
PublishableKey
A publishable, browser-safe API key (pk_prd_… / pk_snd_…).
RadarItemCounts
How many items of a connection are in each sync state.
RadarSyncConnection
An entry’s sync to one Stripe connection.
RadarSyncItem
One identifier’s sync to one Radar value list.
RadarSyncSettingsListResponse
The Radar sync settings of every Stripe connection the caller sees.
RadarSyncSettingsResponse
One Stripe connection’s Radar sync settings.
RadarValueListInfo
A Radar value list a Stripe connection syncs to.
ReInviteUserResponse
The outcome of resending an invitation.
RecordCheckoutEventResponse
Receipt for a recorded buyer-side checkout event.
RecoveryCodesResponse
A freshly generated set of recovery codes. Generating a new set invalidates the previous one.
RecoveryPaymentNotice
The recovery payment announced on a lifecycle webhook.
RefundBulkBlockBuyerResponse
Every refund’s result of a bulk buyer block.
RefundBulkBlockPreviewResponse
What a bulk block of refunds’ buyers would name. Nothing was changed.
RefundBulkBlockResult
One refund’s result of a bulk buyer block.
RefundBulkBuyer
One selected refund’s buyer, as a block would name them.
RefundBulkIdentifier
One identifier a block of a refund’s buyer would name.
RefundExportRecord
One row of a refund export.
RefundLineCredit
What a refund credited to one product line.
RefundResponse
A refund as returned by the API.
RegionCountriesResponse
The country membership of a region.
RegionResponse
A custom region (named country group) scoped to a shop.
RegisterThroughInvitationLinkResponse
The result of making an account through a team invitation link.
RenewalRecoveryPayment
The payment a buyer can make to recover a failed renewal.
RenewalRetryState
The renewal retries of a subscription’s current billing cycle.
ReplayExpiry
When and why a checkout recording was removed.
ReplayIngestRequestclient
Body of CheckoutSession::store_replay_slice, without the client secret the session attaches.
ReplayIngestResponse
What the recorder is told about one stored slice.
ReplayPlaybackResponse
The manifest of a payment’s stored checkout recording, answered when a playback is opened.
ReplaySliceInfo
One slice named in a playback manifest.
ReplaySliceResponse
One slice’s recorded events, read against an open playback.
ResetTeamMemberPasswordResponse
A team member’s temporary password, returned once by a reset.
ResponsePaymentMethodTypes
One payment method type offered for a payment, with what is needed to render it.
ResponsePaymentMethodsEnabled
The method types offered under one broad payment method (card, wallet, …).
ResumeSubscriptionResponse
Returned by Subscriptions::resume.
RetrievePaymentLinkResponse
One payment link, as PaymentLinks::retrieve answers it.
RiskAdjustments
One merchant, project or shop’s adjustments of how its risk is scored.
RiskBands
Where each band begins on the 0 to 100 index. The three values must ascend and stay within 100.
RiskCardTestingIncident
A card-testing burst detected on a connector.
RiskComponentAdjustment
A change to one component’s rule. A part left None keeps the reference model’s value, which may differ per connector.
RiskTuningEstimate
A band and index estimated from stored evidence.
RiskTuningPreviewConnector
The estimate for one shop on one connector.
RiskTuningPreviewResponse
What a change to one scope’s tuning would do. Nothing was stored or scored.
RiskTuningPreviewShop
The estimates for one shop a change reaches.
RiskTuningResponse
One scope’s risk tuning: what it sets, what applies there and where each part comes from, and DeloPay’s reference beside it.
RiskWindowBandOverrides
One window’s band boundaries, overridden together. A window left None inherits its complete boundary set.
RoleConnectorGrantEntry
One connector account in a role’s grant.
RoleConnectorGrantResponse
The connector accounts a role may see.
RoleEntityRef
An entity a role is held on: its ID and, where it has one, its name.
RolePaymentVisibilityPolicy
A role’s explicit payment-data policy. Each visibility is "none" or "read".
RoutableConnectorChoice
A connector the router may pick.
RoutingConfigDeleteResponse
The outcome of soft-deleting a static routing configuration.
RoutingConfigHistoryResponse
One page of a routing configuration’s timeline, oldest first.
RoutingConfigVersion
One content window in a routing configuration’s history.
RoutingConnectorCap
One connector account’s lifetime payment cap for a shop.
RoutingConnectorCapReset
What resetting one limit’s usage cleared.
RoutingConnectorCapSchedule
A shop’s complete dated limit schedule. Gaps between entries use the ordinary configured caps.
RoutingConnectorCapScheduleEntry
One dated limit for an account and unit, applied without restarting usage.
RoutingConnectorCaps
A shop’s connector caps.
RoutingConnectorPaymentRange
One connector account’s per-payment amount range for a shop.
RoutingDecisionAttempt
One attempt of a payment and the routing decision recorded for it.
RoutingDecisionCandidate
A connector a routing decision considered.
RoutingDecisionVolumeCounter
A volume counter a routing decision read.
RoutingDecisionVolumeSplitEntry
One entry of a volume split a routing decision drew from.
RoutingDictionary
Every routing configuration for a merchant, plus which one is active.
RoutingDictionaryRecord
Metadata for one routing configuration, as returned by create, activate, deactivate and the list endpoints. Carries no algorithm body — use the retrieve endpoint for that.
RoutingVolumeCounter
One budget a routing program compares against.
RoutingVolumeCounters
The live routing_volume counters behind a shop’s active advanced program.
SalesRevenueTerm
What a merchant that hosts nobody sold in the period.
SecretKey
A secret API key (prd_… for production, snd_… for sandbox).
SellToRestrictionCapabilitiesResponse
Which checks each payment path performs, and how a buyer’s country is resolved.
SellToRestrictionDecisionResponse
One refusal of a payment by a sell-to policy.
SellToRestrictionDecisionsResponse
Why a payment was refused by sell-to policies.
SellToRestrictionPolicy
A sell-to policy.
SellToRestrictionRailCapability
Which checks one payment path performs.
SellToRestrictionsResponse
The merchant-wide policy and every shop’s effective policy.
SendTestMessageResponse
Where a test message was sent.
SettingActor
The person or credential that last changed a value.
SettingEntry
One setting at the requested scope.
SettingsResponse
Every setting at one scope.
SettlementAdvanceListResponse
The advances recorded against one shop-month.
SettlementBackfillResponse
Outcome of enqueuing a settlement-line backfill.
SettlementBucket
One per-connector/currency rollup inside a statement or the current-period view. Amounts are native minor units of currency.
SettlementCostResponse
What a period’s payments cost, and what was left over. All *_usd figures are USD minor units.
SettlementCurrentResponse
Live rollup of the current (not yet statemented) period.
SettlementLine
One settled payment attempt. Amounts are native minor units of currency.
SettlementLineListResponse
A page of settlement lines.
SettlementOverviewResponse
Per-shop settlement rollup for the host merchant.
SettlementStatementListResponse
A page of generated statements, newest first.
ShopArchiveResponse
A shop’s navigation state after an archive or restore.
ShopFeeConfigEntry
One fee schedule that currently applies to a shop.
ShopFeeConfigResponse
The fee schedules that currently apply to a shop.
ShopLabelDeleteResponse
Outcome of deleting a shop label.
ShopLabelResponse
A label of the merchant and the shops that carry it.
ShopLabelSummary
One label, as a shop carries it.
ShopLabelsResponse
The labels one shop carries.
ShopPaymentsSwitchResponse
A shop’s payments switch after it was set.
ShopResponse
A shop (business profile) as returned by the API.
ShopRiskResponse
One shop’s stored risk across the connectors it processes on.
ShopSellToRestriction
One shop’s effective policy and where it comes from.
ShopSettlementOverview
One shop’s row in the host merchant’s settlement overview.
ShopStats
Order and revenue figures for one shop, as they appear nested inside ProjectStatsResponse.
ShopStatsResponse
Stats for one shop, as returned by the shops.stats endpoint.
ShopVisibilityResponse
Whether a shop’s owner may open their own settlement figures.
StatementAdjustment
One manual position the host added to a statement.
StatementAdjustmentListResponse
The manual adjustments recorded on a statement.
StatementAdvance
A transfer recorded against a shop’s month before that month’s statement exists.
StatementPayout
One recorded transfer against a monthly statement.
StatementPayoutListResponse
Every transfer recorded against one statement.
StripePaymentMethodDomainResult
Outcome of registering one URL as a Stripe payment method domain.
StripePaymentMethodDomainsRegisterResponse
The per-URL outcomes of registering Stripe payment method domains.
SubjectAmlMonitoring
A subject’s verification under ongoing AML monitoring.
SubjectVerification
A subject’s latest verification.
SubjectVerificationResponse
A subject’s latest verification and AML monitoring in one environment.
SubscriptionBillingProcessorResponse
The billing processor a shop’s subscriptions run on.
SubscriptionCapabilities
Which lifecycle actions an existing subscription supports.
SubscriptionCheckoutResponse
The hosted checkout’s bootstrap payload for a subscription, from GET /subscriptions/data/{merchant_id}/{subscription_id}.
SubscriptionDataParamsclient
Query and locale of PaymentLinkSession::subscription_data.
SubscriptionEstimateResponse
Cost estimate for a subscription before creating it, as returned by Subscriptions::estimate.
SubscriptionExportRecord
One row of a subscription export.
SubscriptionImportApplyResponse
The results of an import, one per selection in request order.
SubscriptionImportCapabilities
What the import can do on one billing processor.
SubscriptionImportCounts
How many listed subscriptions fell into each classification.
SubscriptionImportItem
One subscription the processor holds, as the import classifies it.
SubscriptionImportPreviewResponse
What a billing account holds at its processor, classified against DeloPay’s subscriptions.
SubscriptionImportResult
One selection’s import result.
SubscriptionInvoice
A single invoice raised for one billing cycle of a subscription.
SubscriptionInvoiceListResponse
One subscription’s billing history, newest cycle first.
SubscriptionItem
A subscription item (plan or addon) with its available prices, as returned by Subscriptions::items.
SubscriptionItemPrice
A purchasable price option for a subscription item (plan or addon).
SubscriptionLineItem
A single line of a subscription cost estimate.
SubscriptionMethodOption
One method a buyer may pick for a subscription waiting for the choice.
SubscriptionMethodOptionsResponse
The methods a buyer may pick for a subscription, in the shop’s order, judged by the shop’s currencies, amount limits and sell-to policies for the country of the request’s own connection.
SubscriptionPaymentData
Payment leg attached to a subscription’s current billing cycle, present once a charge has been attempted.
SubscriptionPaymentLink
One resolved payment → subscription link.
SubscriptionPaymentLookupResponse
The resolved subset of a batch of payment ids.
SubscriptionProviderRead
One read of a subscription at its billing processor.
SubscriptionResponse
A subscription, as returned by create / retrieve / update / list.
SubscriptionReturnSessionclient
Reads the status a buyer coming back from the processor’s checkout may see, authenticated with the return token (rt) the return URL carried.
SubscriptionReturnStatusResponse
What a buyer coming back from the processor’s checkout may read about their subscription with the return token alone.
SubscriptionSyncResponse
The results of a batch sync, one per requested ID in request order.
SubscriptionSyncResult
One subscription’s sync result.
SurchargeRuleResponse
A stored surcharge program: the structured configuration plus its version metadata and any server-side advisories.
TeamMemberContactChannel
One further contact channel of a team member.
TeamMemberContactProfileResponse
A member’s supplied contacts and the internal notes kept about them.
TeamMemberContacts
A team member’s supplied contacts.
TeamMemberDetailsResponse
One member of the caller’s merchant, with the person fields the member list omits.
TeamMemberNote
One internal note about a team member.
TeamMemberNoteActor
The user who wrote or edited a team-member note.
TestEmailResponse
The outcome of a test reminder sent to the signed-in user’s own address.
TierSummary
The merchant’s currently-locked platform-fee volume tier.
TokenResponse
A freshly minted single-purpose token, returned by the email-token exchange, the two-factor terminate step and employee impersonation.
TopupResponse
The result of a manual balance top-up.
TotpResponse
The result of starting TOTP setup.
TotpSecret
The TOTP enrolment material: the shared secret and the otpauth:// URI a dashboard renders as a QR code.
TourAccessGroup
One permission area and the scopes held over it.
TourActive
The dashboard tour in progress.
TourBaseline
A dashboard-tour baseline.
TourProgress
A user’s progress through the dashboard tour in one scope.
TransactionExportRecord
One row of a transaction export.
TransactionLineExportRecord
One row of a transaction line export: one per product line a payment recorded, and one with row_kind == "no_lines" for each payment that recorded none, so every payment of the per-payment export is present.
UpdateMemberExpiryResponse
A team member’s access expiry after an update.
UserInLineage
One member of the caller’s lineage.
UserPreferenceResponse
One of the signed-in user’s own preferences. A None value means no preference is saved: use your defaults.
UserResponse
The authenticated user’s own details, as returned by the profile, update and password-change endpoints.
UserSessionEntry
One currently-active dashboard session — a single minted login JWT.
UserSessionListResponse
The authenticated user’s active sessions.
UserSessionRevokeResponse
The result of disconnecting one of the user’s sessions.
VaultCheck
One vault configuration check.
VaultCollectSessionResponse
What a checkout page needs to stand up a VGS Collect form.
VaultOutage
One shop whose vault account refuses the API.
VaultOutagesResponse
The shops whose switched-on vault account has stopped working.
VaultPaymentMethodRequestclient
Body for PaymentLinkSession::register_vault_payment_method.
VaultPaymentMethodResponse
The registered vault card, plus the one-shot token that pays with it.
VaultProcessorHiding
Whether one processor’s card payments can be hidden behind a vault.
VaultRouteApplyVerification
What a read-back after writing vault routes established.
VaultRouteChange
One route change of a vault route preview.
VaultRouteIds
The ids of a vault’s collect and reveal routes.
VaultRouteWarning
A non-blocking advisory about vault routes.
VaultRoutesApplyResponse
The result of writing a vault connector’s routes.
VaultRoutesPreviewResponse
The route document a vault connector should have, diffed against what exists. Nothing is written.
VaultSwitchOffResponse
A shop after its card vault was switched off.
VaultVerificationResponse
The configuration checks of a vault connector account.
VerificationCheck
One check of a verification and its result.
WebhookAddressConstraints
The limits a callback address must keep to.
WebhookAddressEnvironment
The callback address of one environment.
WebhookAddressFormat
The identifier format of an anonymous callback address.
WebhookAddressPreviewGroup
One credential group a proposed callback address affects.
WebhookAddressPreviewResponse
The result of validating a proposed callback address. Nothing is saved.
WebhookAddressRateLimit
How many callback-address changes remain.
WebhookAddressResponse
The callback addresses of a merchant’s accounts at one payment provider.
WebhookAddressValidationError
Why a proposed callback address is not valid.
WebhookContent
The tagged payload of a webhook event: { "type": …, "object": … }.
WebhookEvent
A parsed, signature-verified DeloPay webhook event.
WhopApplePayDomainResult
One URL’s outcome in WhopApplePayDomainsRegisterResponse.
WhopApplePayDomainsRegisterResponse
The per-URL outcomes of registering Apple Pay domains on a Whop account.
WhopResolutionCase
A Whop resolution case as Whop reports it now.
WhopResolutionCaseActionResponse
The result of an action on a case.
WhopResolutionCaseAttachment
A file attached to a case event.
WhopResolutionCaseEvent
One event of a case’s timeline.
WhopResolutionCaseEventList
One page of a case’s timeline, newest first.
WhopResolutionCaseList
One page of Whop cases, newest first.

Enums§

ActiveRoutingConfig
What the active-routing endpoint returns: either the merchant-account envelope, or a list of profile-based records.
AuthenticationType
Whether to request 3-D Secure authentication.
BundlePricing
How a bundle is priced.
CaptureMethod
How and when funds are captured.
CustomerIdentityImportOutcome
What became of one import row.
CustomerShopPlacementOutcome
What placing a customer in a shop did.
DefaultProfileRouting
What the default-profile-routing endpoint returns: either a flat connector list (merchant-wide default) or one entry per profile.
DelopayError
Everything that can go wrong talking to DeloPay.
FeeOwner
Who owns a fee schedule or fee-rule program.
LogEventclient
One thing worth logging, handed to a DelopayLogger.
MessageTemplateContent
A template’s text in one language, in one of two modes: the branded layout filled with the parts below, or a whole HTML document.
PriceBillingState
Whether one recurring price can start a subscription on the shop’s billing processor account, in the environment the account is in now.
ProductAliasKind
Whether a name is the product’s current name or another name it goes by.
ProductImportClassification
How a provider item relates to the catalogue right now.
ProductImportPriceState
How one provider price relates to the catalogue.
ProductKind
What a catalogue product is sold as.
ProductMappingMode
How a connected account’s product or price was tied to a catalogue product.
ProductMatch
What a product was resolved by.
ProductPriceInterval
The unit a recurring price bills in, and the unit a trial is measured in.
ProductPriceTaxBehavior
Whether a price’s amount includes tax or has it added on top by the billing processor.
ProductStatus
Whether a product, a price or a category is still in use.
ProviderArchiveAction
What to do at one connected account when a product is deleted or archived there.
ProviderArchiveMode
How a provider can be cleaned up when a product is deleted.
ProviderArchiveStatus
What an archive did at one connected account.
ProviderEnvironment
A connected account’s environment.
ProviderPushAction
What a push to the provider does about one difference.
ProviderSyncField
A field compared between the catalogue and the provider.
ProviderSyncStatus
How a connected account’s copy of a product compares with the catalogue.
ProviderUnavailableReason
Why the catalogue cannot work with a connected account right now.
RefundType
Refund processing type.
SetupFutureUsage
Whether to save the payment method for future use.
SubscriptionCheckoutMethodclient
A payment method a buyer can pick in the hosted subscription checkout.
SurchargeCondition
One condition on the payment itself, ANDed with a surcharge entry’s scope.

Constants§

CHECKOUT_URL
Hosted-checkout base URL (the shopper-facing pay page).
PRODUCTION_URL
Production API base URL.
SANDBOX_URL
Sandbox API base URL.

Functions§

currency_exponent
How many decimal digits currency’s minor unit has: 2 for EUR, 0 for JPY, 3 for KWD.

Type Aliases§

AllocationStatus
Status of a per-shop balance allocation, e.g. "active", "suspended".
AuthenticationStatus
Lifecycle status of a 3DS authentication, e.g. "started", "success", "failed". A string rather than an enum so a new status does not break deserialization.
BillingStatus
Billing lifecycle status of a merchant, e.g. "active", "suspended", "setup_incomplete". Open vocabulary — kept as a string so a new backend value cannot break deserialization.
BlockReason
Why a payment attempt was rejected by the billing gate: "billing_suspended", "billing_setup_incomplete", or "allocation_suspended".
CancelModeOutcome
Whether a cancellation was performed the way it was asked for.
ConnectorHealthState
The overall health verdict for a connector account: "healthy", "degraded", "cannot_accept_payments" or "unknown".
ConnectorHealthUnknownReason
Why a connector’s health could not be established, present exactly when the state is "unknown".
ConnectorOwnership
Who owns the connector a settlement line ran through: "host", "shop", or "unknown" for lines frozen before ownership tracking existed.
ConnectorSettlementStatus
What the payment’s rail says about settling one attempt.
DelopayLoggerclient
A sink for LogEvents, installed with DelopayBuilder::logger.
DisputeOutcomeReporting
Whether a processor tells DeloPay how a dispute ended.
EventType
The event types the API raises.
ExpenseAllocation
How a period expense that only partly overlaps the report window is counted: "pro_rata_days" or "not_applied".
FailureSubstatus
Why a payment failed or was declined, e.g. "insufficient_funds". A substatus this crate does not know reads as declined_other / failed_other on the API side; here it arrives verbatim.
InvoiceAmountState
Whether an invoice’s amount is a figure at all.
InvoiceAutoIssue
Whether a paid payment or subscription cycle gets its invoice without a request: off, draft (a draft to check and finalise by hand) or finalize (issued; a document that cannot be finalised stays a draft).
InvoiceBuyerType
Which buyers a tax rule applies to: any, business (a VAT id or a tax number), vat_registered (a VAT id) or consumer (neither).
InvoiceDocumentStatus
Where a document is in its life: draft, issued or voided.
InvoiceEmailDeliveryStatus
What the mail provider reported about a message after accepting it: bounced or complained.
InvoiceEmailOrigin
Why a message to the buyer was queued: automatic (the shop mails every invoice it issues) or manual (a send by hand).
InvoiceEmailStatus
What became of a message to the buyer: queued, sending, sent, failed or skipped.
InvoiceKind
invoice or credit_note.
InvoiceLineRole
What a line is: product, addon, bundle, component, surcharge or shipping. surcharge is the difference between what the buyer was charged and what the sold lines add up to.
InvoiceLineTaxSource
How a line’s tax was decided: processor, reported, rule, default or manual.
InvoiceLocale
The document’s language: en, de, fr, es, it, nl, pt or pl.
InvoiceLocaleMode
How a document’s language is chosen: fixed (always locale) or buyer_country (the buyer country’s language where supported).
InvoiceNoTaxRuleReason
Why a tax rule shows no tax: reverse_charge, exempt, export, outside_scope or small_business.
InvoiceProcessorTaxMode
Whether a stated order tax decides the lines’ tax: prefer_processor or ignore.
InvoiceSettingSource
Where an effective setting or a rule list came from: shop, merchant or default.
InvoiceSourceKind
What a document is for: payment or subscription_cycle.
InvoiceTaxMode
vat shows VAT at the default rate on gross prices; no_vat shows none and needs a reason.
InvoiceTaxRuleKind
What a tax rule decides: rate (tax at rate_bp) or no_tax.
ManualTriggerEventType
The event types a manual fire accepts: the twelve payment and refund types listed on EventType.
MarginQuality
How much weight SettlementCostResponse::margin_usd carries: "exact", "upper_bound" (the real figure is this or lower) or "unknown" (no figure is published).
MerchantAuditActorKind
The parties a merchant can see in their own log.
MerchantAuditImpersonationKind
Which relationship an impersonated change was made under.
MerchantCostRuleCategory
What a cost rule records: "goods", "partner_share" or "other".
NativeMinor
Native settlement money: minor units as a decimal string.
NativeRecoveryMode
How a failed renewal is recovered once its off-session charges have failed: "off", or "buyer_link" (a payment the buyer pays on the hosted page).
NativeSettlementQuality
Whether a native settlement calculation is final or still provisional: "complete" or "provisional".
OperationLimitUnlimitedReason
Why no limit applies to the caller for an operation: "no_rule" or "admin_exempt".
ParentGroup
A top-level permission group recognized by the Delopay API, e.g. "Operations", "Connectors", "Users". A string so new groups do not break deserialization.
PaymentIdStyle
Charset used for the random body of a custom-format payment ID, e.g. "numeric", "alphanumeric", "alphanumeric_uppercase".
PaypalDisputeAction
A seller action PayPal offers on a case.
PermissionScope
A permission scope: "Read" allows viewing, "Write" is required for any mutation.
ProcessorCostBasis
What the figures of a cost rollup rest on: "reported" (observations from the rails), "estimated" (configured rates), "mixed" or "none".
ProjectDepthSource
Where a merchant’s project depth limit comes from: "default", "platform" or "merchant_override".
Result
Convenient result alias used throughout the crate.
RevenueBasis
Which revenue a margin is a margin on: "hosting_fee" (what a host charged its shops) or "merchant_sales" (a merchant’s own captured sales). The two are never added.
RoutingApproach
The category of routing decision behind an attempt — never the rule that fired.
SettlementPayoutStatus
Payout progress of a settlement statement.
SubscriptionImportClassification
How a processor subscription relates to DeloPay: "new", "needs_customer", "held", "ended" or "not_adoptable".
SubscriptionImportOutcome
What taking one subscription over did: "adopted", "already_held" or "failed".
SubscriptionImportReason
Why the import cannot list, offer or take over a subscription, as a code to word: e.g. "listing_unsupported", "adoption_disabled".
SubscriptionSyncOutcome
What reading one subscription back from its processor did: "updated", "unchanged", "undated", "not_at_processor", "not_found" or "failed".
SurchargeDirection
Whether an adjustment adds to or takes off the buyer’s total: "surcharge" or "discount".
SuspensionSource
What caused a suspension: "auto_recharge" (automatic, lifted by a successful top-up) or "admin" (sticky, lifted only by an admin).
TermBearer
Whose money a term of the cost model comes out of: "merchant" or "shop_owner".
TokenPurpose
Purpose of a single-purpose JWT, e.g. "totp", "reset_password", "sso", "verify_email". A string rather than an enum so a new purpose minted by the API does not break deserialization.
TransactionType
What a routing algorithm applies to, e.g. "payment", "payout", "three_ds_authentication". Open vocabulary — kept as a string so a new backend value cannot break deserialization.
WebhookDeliveryAttempt
What kind of delivery a webhook row records: "initial_attempt", "automatic_retry", "manual_retry" or "manual_trigger".