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, theresourcesmodule, retries. Pulls inhyper,hyper-rustlsandtokio.
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;clientpub use resources::api_keys::ApiKeyCreateResponse;clientpub use resources::api_keys::ApiKeyResponse;clientpub use resources::api_keys::ApiKeyRevokeResponse;clientpub use resources::api_keys::ApiKeyUpdateRequest;clientpub use resources::api_keys::ApiKeys;clientpub use resources::audit::Audit;clientpub use resources::audit::MerchantAuditLogListParams;clientpub use resources::authentication::Authentication;clientpub use resources::authentication::AuthenticationCreateRequest;clientpub use resources::availability_overrides::AvailabilityOverrideCreateRequest;clientpub use resources::availability_overrides::AvailabilityOverrides;clientpub use resources::availability_overrides::AvailabilityPreviewParams;clientpub use resources::availability_overrides::OverrideAction;clientpub use resources::availability_overrides::OverrideScope;clientpub use resources::billing::AllocationTransferRequest;clientpub use resources::billing::AutoRechargeUpdateRequest;clientpub use resources::billing::Billing;clientpub use resources::billing::BillingAllocations;clientpub use resources::billing::BillingCompleteSetupRequest;clientpub use resources::billing::BillingSetupRequest;clientpub use resources::billing::BlockedAttemptListParams;clientpub use resources::billing::LedgerListParams;clientpub use resources::billing::TopupRequest;clientpub use resources::buyer_account::BuyerAccount;clientpub use resources::buyer_account::BuyerAccountConfirmRequest;clientpub use resources::buyer_account::BuyerAccountPurchaseParams;clientpub use resources::buyer_account::BuyerAccountSectionParams;clientpub use resources::buyer_account::BuyerAccountSignInRequest;clientpub use resources::buyer_account::BuyerAccountVerifyCodeRequest;clientpub use resources::buyer_account::BuyerAccountVerifyLinkRequest;clientpub use resources::buyer_account::BuyerNoticeSettingsRequest;clientpub use resources::buyer_blocklist::BuyerBlocklist;clientpub use resources::buyer_blocklist::BuyerBlocklistEntryCreateRequest;clientpub use resources::buyer_blocklist::BuyerBlocklistEntryDeleteRequest;clientpub use resources::buyer_blocklist::BuyerBlocklistFromPaymentPreviewRequest;clientpub use resources::buyer_blocklist::BuyerBlocklistFromPaymentRequest;clientpub use resources::buyer_blocklist::BuyerBlocklistIpClass;clientpub use resources::buyer_blocklist::BuyerBlocklistKind;clientpub use resources::buyer_blocklist::BuyerBlocklistListParams;clientpub use resources::buyer_blocklist::BuyerBlocklistListScope;clientpub use resources::buyer_blocklist::BuyerBlocklistTraitAction;clientpub use resources::buyer_blocklist::PaymentBlockIdentifier;clientpub use resources::buyer_blocklist::PaymentBlockScope;clientpub use resources::buyer_blocklist::RadarEfwAction;clientpub use resources::buyer_blocklist::RadarReviewAction;clientpub use resources::buyer_blocklist::RadarSyncSettingsUpdateRequest;clientpub use resources::buyer_conversations::BuyerConversationAssignRequest;clientpub use resources::buyer_conversations::BuyerConversationListParams;clientpub use resources::buyer_conversations::BuyerConversationMessagesParams;clientpub use resources::buyer_conversations::BuyerConversationNoteRequest;clientpub use resources::buyer_conversations::BuyerConversationReplyRequest;clientpub use resources::buyer_conversations::BuyerConversationStartRequest;clientpub use resources::buyer_conversations::BuyerConversationStatusRequest;clientpub use resources::buyer_conversations::BuyerConversations;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceInformationRequest;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceNote;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceOutcome;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceQueueParams;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceReply;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceReviewCreate;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceReviews;clientpub use resources::buyer_evidence_reviews::BuyerEvidenceState;clientpub use resources::buyer_portal::BuyerAttachmentParams;clientpub use resources::buyer_portal::BuyerConversationParams;clientpub use resources::buyer_portal::BuyerEvidenceExtensionRequest;clientpub use resources::buyer_portal::BuyerEvidenceSubmitRequest;clientpub use resources::buyer_portal::BuyerFileUpload;clientpub use resources::buyer_portal::BuyerMessageCreateRequest;clientpub use resources::buyer_portal::BuyerPortal;clientpub use resources::buyer_portal::BuyerPortalContactEmailCommand;clientpub use resources::buyer_portal::BuyerPortalPageParams;clientpub use resources::buyer_portal::BuyerPortalPlanChangeRequest;clientpub use resources::buyer_portal::BuyerPortalProfileUpdateRequest;clientpub use resources::buyer_portal::BuyerPortalRefundRequestCreateRequest;clientpub use resources::buyer_portal::BuyerPortalSubscriptionActionRequest;clientpub use resources::buyer_portal::NativeEnrollmentRequest;clientpub use resources::chargeback_prevention::ChargebackPrevention;clientpub use resources::chargeback_prevention::PreventionCaseListParams;clientpub use resources::chargeback_prevention::PreventionRefundActionListParams;clientpub use resources::chargeback_prevention::PreventionRefundPreviewRequest;clientpub use resources::chargeback_prevention::PreventionRefundRuleSettings;clientpub use resources::checkout_methods::CheckoutAccountVisibilityRequest;clientpub use resources::checkout_methods::CheckoutEntriesUpdateRequest;clientpub use resources::checkout_methods::CheckoutEnvironment;clientpub use resources::checkout_methods::CheckoutMethods;clientpub use resources::checkout_methods::CheckoutMethodsAvailabilityParams;clientpub use resources::checkout_methods::CheckoutMethodsChildrenParams;clientpub use resources::checkout_methods::CheckoutMethodsUpdateRequest;clientpub use resources::checkout_methods::CheckoutRedirectRulesTestRequest;clientpub use resources::checkout_recovery::CandidatePreviewRequest;clientpub use resources::checkout_recovery::CheckoutRecovery;clientpub use resources::checkout_recovery::CheckoutReminderListParams;clientpub use resources::checkout_recovery::ManualEmailRequest;clientpub use resources::checkout_recovery::ReactivateCheckoutRequest;clientpub use resources::checkout_recovery::ReminderScenario;clientpub use resources::checkout_recovery::TestEmailRequest;clientpub use resources::checkout_templates::CheckoutTemplateApplyRequest;clientpub use resources::checkout_templates::CheckoutTemplateAssignRequest;clientpub use resources::checkout_templates::CheckoutTemplateCreateRequest;clientpub use resources::checkout_templates::CheckoutTemplateUpdateRequest;clientpub use resources::checkout_templates::CheckoutTemplates;clientpub use resources::connectors::AirwallexApplePayDomainsRegisterRequest;clientpub use resources::connectors::ConnectorBuyerMailUpdateRequest;clientpub use resources::connectors::ConnectorConsolidationRequest;clientpub use resources::connectors::ConnectorCreateRequest;clientpub use resources::connectors::ConnectorCreateWebhookAddress;clientpub use resources::connectors::ConnectorCurrencyPolicyUpdateRequest;clientpub use resources::connectors::ConnectorHealthParams;clientpub use resources::connectors::ConnectorShopUpdateRequest;clientpub use resources::connectors::ConnectorShopsAddRequest;clientpub use resources::connectors::ConnectorUpdateRequest;clientpub use resources::connectors::ConnectorWebhookRegisterRequest;clientpub use resources::connectors::Connectors;clientpub use resources::connectors::ProviderWebhookConfirmation;clientpub use resources::connectors::ProviderWebhookCreateRequest;clientpub use resources::connectors::ProviderWebhookDeleteRequest;clientpub use resources::connectors::ProviderWebhookReplaceRequest;clientpub use resources::connectors::ProviderWebhookUpdateRequest;clientpub use resources::connectors::StripePaymentMethodDomainsRegisterRequest;clientpub use resources::connectors::VaultRoutesApplyRequest;clientpub use resources::connectors::VaultRoutesPreviewRequest;clientpub use resources::connectors::VaultVerifyRequest;clientpub use resources::connectors::WebhookAddressRequest;clientpub use resources::connectors::WhopApplePayDomainsRegisterRequest;clientpub use resources::cost_rules::CostRules;clientpub use resources::cost_rules::CreateMerchantCostRuleRequest;clientpub use resources::cost_rules::UpdateMerchantCostRuleRequest;clientpub use resources::customers::BuyerInvoiceLinkRequest;clientpub use resources::customers::BuyerPortalLinkListParams;clientpub use resources::customers::CustomerCreateRequest;clientpub use resources::customers::CustomerIdentityHistoryRequest;clientpub use resources::customers::CustomerIdentityHistorySearchRequest;clientpub use resources::customers::CustomerIdentityImportPreviewRequest;clientpub use resources::customers::CustomerIdentityImportRequest;clientpub use resources::customers::CustomerIdentityImportRow;clientpub use resources::customers::CustomerListParams;clientpub use resources::customers::Customers;clientpub use resources::customers::MAX_IDENTITY_CUSTOMERS;clientpub use resources::customers::MAX_IDENTITY_HISTORY_REQUEST_BYTES;clientpub use resources::customers::MAX_IDENTITY_IMPORT_REQUEST_BYTES;clientpub use resources::customers::MAX_IDENTITY_IMPORT_ROWS;clientpub use resources::customers::MAX_IDENTITY_SEARCH_QUERY_CHARS;clientpub use resources::customers::MAX_IDENTITY_SEARCH_RESULTS;clientpub use resources::deployment_branding::BrandingAsset;clientpub use resources::deployment_branding::DeploymentBranding;clientpub use resources::deployment_branding::branding_asset_path;clientpub use resources::disputes::DisputeBulkAcceptRequest;clientpub use resources::disputes::DisputeBulkAction;clientpub use resources::disputes::DisputeBulkBlockBuyerRequest;clientpub use resources::disputes::DisputeBulkPreviewRequest;clientpub use resources::disputes::DisputeEvidenceRequest;clientpub use resources::disputes::DisputeListParams;clientpub use resources::disputes::DisputeReconcileRequest;clientpub use resources::disputes::DisputeRefundAssociationRequest;clientpub use resources::disputes::DisputeWorkspaceParams;clientpub use resources::disputes::DisputeWorkspaceSortBy;clientpub use resources::disputes::Disputes;clientpub use resources::disputes::SortDirection;clientpub use resources::ephemeral_keys::EphemeralKeys;clientpub use resources::events::EventListParams;clientpub use resources::events::EventManualTriggerRequest;clientpub use resources::events::Events;clientpub use resources::export::Export;clientpub use resources::export::ExportFormat;clientpub use resources::export::MAX_EXPORT_PRESENTATION_BYTES;clientpub use resources::external_records::ExternalRecordEnvironment;clientpub use resources::external_records::ExternalRecordRequest;clientpub use resources::external_records::ExternalRecordResource;clientpub use resources::external_records::ExternalRecords;clientpub use resources::fees::FeeScheduleCreateRequest;clientpub use resources::fees::FeeScheduleUpdateRequest;clientpub use resources::fees::FeeType;clientpub use resources::fees::Fees;clientpub use resources::identity_verifications::IdentityVerificationCreateRequest;clientpub use resources::identity_verifications::IdentityVerificationListParams;clientpub use resources::identity_verifications::IdentityVerifications;clientpub use resources::identity_verifications::VerificationKind;clientpub use resources::invoice_settings::InvoiceLogoRequest;clientpub use resources::invoice_settings::InvoicePreviewRequest;clientpub use resources::invoice_settings::InvoiceSettings;clientpub use resources::invoice_settings::InvoiceSettingsRequest;clientpub use resources::invoice_settings::InvoiceTaxRuleBuyer;clientpub use resources::invoice_settings::InvoiceTaxRuleEvaluateRequest;clientpub use resources::invoice_settings::InvoiceTaxRulesRequest;clientpub use resources::invoices::CreateCreditNoteRequest;clientpub use resources::invoices::CreateInvoiceRequest;clientpub use resources::invoices::CreditNoteLine;clientpub use resources::invoices::InvoiceBuyer;clientpub use resources::invoices::InvoiceExportFormat;clientpub use resources::invoices::InvoiceExportParams;clientpub use resources::invoices::InvoiceListParams;clientpub use resources::invoices::InvoicePageParams;clientpub use resources::invoices::InvoiceSourceRef;clientpub use resources::invoices::Invoices;clientpub use resources::invoices::UpdateInvoiceLine;clientpub use resources::invoices::UpdateInvoiceRequest;clientpub use resources::invoices::VoidInvoiceRequest;clientpub use resources::live::Live;clientpub use resources::live::LiveVersionsParams;clientpub use resources::mandates::Mandates;clientpub use resources::merchant_accounts::MerchantAccountCreateRequest;clientpub use resources::merchant_accounts::MerchantAccountUpdateRequest;clientpub use resources::merchant_accounts::MerchantAccounts;clientpub use resources::message_templates::MessageTemplateLanguageUpdateRequest;clientpub use resources::message_templates::MessageTemplatePreviewRequest;clientpub use resources::message_templates::MessageTemplates;clientpub use resources::message_templates::SendTestMessageRequest;clientpub use resources::operation_limits::OperationLimits;clientpub use resources::payment_links::PaymentLinkListParams;clientpub use resources::payment_links::PaymentLinks;clientpub use resources::payment_methods::CardUpdate;clientpub use resources::payment_methods::CustomerPaymentMethodsListParams;clientpub use resources::payment_methods::PaymentMethodCreateRequest;clientpub use resources::payment_methods::PaymentMethodListParams;clientpub use resources::payment_methods::PaymentMethodPresentationParams;clientpub use resources::payment_methods::PaymentMethodUpdateRequest;clientpub use resources::payment_methods::PaymentMethods;clientpub use resources::payments::MAX_ABORT_REASON_CHARS;clientpub use resources::payments::OrderDetailsWithAmount;clientpub use resources::payments::PaymentAbortRequest;clientpub use resources::payments::PaymentAddonChoice;clientpub use resources::payments::PaymentCancelRequest;clientpub use resources::payments::PaymentCaptureRequest;clientpub use resources::payments::PaymentConfirmRequest;clientpub use resources::payments::PaymentCreateRequest;clientpub use resources::payments::PaymentListParams;clientpub use resources::payments::PaymentUpdateRequest;clientpub use resources::payments::Payments;clientpub use resources::payouts::PayoutCreateRequest;clientpub use resources::payouts::PayoutListParams;clientpub use resources::payouts::PayoutUpdateRequest;clientpub use resources::payouts::Payouts;clientpub use resources::paypal_disputes::PaypalDisputeActionRequest;clientpub use resources::paypal_disputes::PaypalDisputeImportRequest;clientpub use resources::paypal_disputes::PaypalDisputeListParams;clientpub use resources::paypal_disputes::PaypalDisputes;clientpub use resources::poll::Poll;clientpub use resources::processor_costs::BulkCreateProcessorCostSchedulesRequest;clientpub use resources::processor_costs::CreateProcessorCostScheduleRequest;clientpub use resources::processor_costs::ProcessorCosts;clientpub use resources::processor_costs::ReplaceProcessorCostScheduleRequest;clientpub use resources::processor_costs::UpdateProcessorCostScheduleRequest;clientpub use resources::processor_imports::ProcessorImports;clientpub use resources::processor_imports::PspImportCreateRequest;clientpub use resources::processor_imports::PspImportRecordType;clientpub use resources::products::AddonGroupCreateRequest;clientpub use resources::products::AddonGroupUpdateRequest;clientpub use resources::products::BundleDefinition;clientpub use resources::products::BundleItemRequest;clientpub use resources::products::ProductAliasCreateRequest;clientpub use resources::products::ProductCategoryCreateRequest;clientpub use resources::products::ProductCategoryListParams;clientpub use resources::products::ProductCategoryReorderRequest;clientpub use resources::products::ProductCategoryUpdateRequest;clientpub use resources::products::ProductConnectorReferenceCreateRequest;clientpub use resources::products::ProductCreateRequest;clientpub use resources::products::ProductDeleteRequest;clientpub use resources::products::ProductImportAcceptRequest;clientpub use resources::products::ProductImportApplyRequest;clientpub use resources::products::ProductImportArchivedAtProvider;clientpub use resources::products::ProductImportMixedDecision;clientpub use resources::products::ProductImportOptions;clientpub use resources::products::ProductImportPreviewRequest;clientpub use resources::products::ProductImportScope;clientpub use resources::products::ProductImportSuggestionsParams;clientpub use resources::products::ProductListParams;clientpub use resources::products::ProductPriceCreateRequest;clientpub use resources::products::ProductPriceUpdateRequest;clientpub use resources::products::ProductProviderCreateRequest;clientpub use resources::products::ProductProviderPushRequest;clientpub use resources::products::ProductProviderSyncBatchRequest;clientpub use resources::products::ProductResolveQuery;clientpub use resources::products::ProductSalesParams;clientpub use resources::products::ProductUpdateRequest;clientpub use resources::products::Products;clientpub use resources::products::ProviderArchiveRequest;clientpub use resources::profile_acquirers::ProfileAcquirerCreateRequest;clientpub use resources::profile_acquirers::ProfileAcquirerUpdateRequest;clientpub use resources::profile_acquirers::ProfileAcquirers;clientpub use resources::profiles::ProfileCreateRequest;clientpub use resources::profiles::ProfileUpdateRequest;clientpub use resources::profiles::Profiles;clientpub use resources::projects::ProjectCreateRequest;clientpub use resources::projects::ProjectUpdateRequest;clientpub use resources::projects::Projects;clientpub use resources::projects::StatsPeriod;clientpub use resources::refunds::BuyerRefundRequestApprove;clientpub use resources::refunds::BuyerRefundRequestDecline;clientpub use resources::refunds::BuyerRefundRequestListParams;clientpub use resources::refunds::BuyerRefundRequestStatus;clientpub use resources::refunds::RefundBulkBlockBuyerRequest;clientpub use resources::refunds::RefundBulkBlockPreviewRequest;clientpub use resources::refunds::RefundBulkExcludedIdentifier;clientpub use resources::refunds::RefundCreateRequest;clientpub use resources::refunds::RefundLineCreditRequest;clientpub use resources::refunds::RefundUpdateRequest;clientpub use resources::refunds::Refunds;clientpub use resources::regions::RegionCreateRequest;clientpub use resources::regions::RegionSetCountriesRequest;clientpub use resources::regions::RegionUpdateRequest;clientpub use resources::regions::Regions;clientpub use resources::relay::Relay;clientpub use resources::relay::RelayCaptureData;clientpub use resources::relay::RelayData;clientpub use resources::relay::RelayIncrementalAuthorizationData;clientpub use resources::relay::RelayRefundData;clientpub use resources::relay::RelayRequest;clientpub use resources::relay::RelayType;clientpub use resources::relay::RelayVoidData;clientpub use resources::risk::Risk;clientpub use resources::risk::RiskTuningTarget;clientpub use resources::risk::RiskTuningUpdateRequest;clientpub use resources::routing::CheckoutThemeConversionParams;clientpub use resources::routing::CheckoutThemeProgramRequest;clientpub use resources::routing::CheckoutThemeRules;clientpub use resources::routing::ConnectorCapOverrideRequest;clientpub use resources::routing::MethodSurcharge;clientpub use resources::routing::PerMethodSurchargeItem;clientpub use resources::routing::Routing;clientpub use resources::routing::RoutingActivatePayload;clientpub use resources::routing::RoutingConfigCreateRequest;clientpub use resources::routing::RoutingConnectorCapResetRequest;clientpub use resources::routing::RoutingConnectorCapScheduleShuffle;clientpub use resources::routing::RoutingDeactivateRequest;clientpub use resources::routing::SurchargeRuleRequest;clientpub use resources::routing::SurchargeRules;clientpub use resources::sell_to_restrictions::SellToRestrictionPolicyRequest;clientpub use resources::sell_to_restrictions::SellToRestrictions;clientpub use resources::settings::SettingChangeRequest;clientpub use resources::settings::Settings;clientpub use resources::settings::UpdateSettingsRequest;clientpub use resources::settlement::NativeSettlementFeeRefreshRequest;clientpub use resources::settlement::NativeSettlementListParams;clientpub use resources::settlement::NativeSettlementPayoutCreateRequest;clientpub use resources::settlement::NativeSettlementReportCreateRequest;clientpub use resources::settlement::ProcessorCostEventsParams;clientpub use resources::settlement::Settlement;clientpub use resources::settlement::SettlementBackfillRequest;clientpub use resources::settlement::SettlementCostParams;clientpub use resources::settlement::SettlementLineListParams;clientpub use resources::settlement::StatementAdjustmentCreateRequest;clientpub use resources::settlement::StatementAdvanceRecordRequest;clientpub use resources::settlement::StatementGenerateRequest;clientpub use resources::settlement::StatementListParams;clientpub use resources::settlement::StatementPayoutRecordRequest;clientpub use resources::settlement::StatementPayoutUpdateRequest;clientpub use resources::settlement::StatementPdfParams;clientpub use resources::shop_labels::ShopLabelCreateRequest;clientpub use resources::shop_labels::ShopLabelUpdateRequest;clientpub use resources::shop_labels::ShopLabels;clientpub use resources::shop_labels::ShopLabelsSetRequest;clientpub use resources::shops::GatewayConnectRequest;clientpub use resources::shops::ShopCreateRequest;clientpub use resources::shops::ShopGateways;clientpub use resources::shops::ShopUpdateRequest;clientpub use resources::shops::Shops;clientpub use resources::stripe_connect::StripeConnect;clientpub use resources::stripe_connect::StripeConnectAccountRequest;clientpub use resources::stripe_connect::StripeConnectLinkRequest;clientpub use resources::subscriptions::AdoptSubscriptionRequest;clientpub use resources::subscriptions::CancelSubscriptionRequest;clientpub use resources::subscriptions::ConfirmSubscriptionPaymentDetails;clientpub use resources::subscriptions::ConfirmSubscriptionRequest;clientpub use resources::subscriptions::CreateAndConfirmSubscriptionRequest;clientpub use resources::subscriptions::CreateSubscriptionPaymentDetails;clientpub use resources::subscriptions::CreateSubscriptionRequest;clientpub use resources::subscriptions::NativeDunningConfigRequest;clientpub use resources::subscriptions::NativeShopConfigRequest;clientpub use resources::subscriptions::PAYMENT_LOOKUP_MAX_IDS;clientpub use resources::subscriptions::PauseSubscriptionRequest;clientpub use resources::subscriptions::ResumeSubscriptionRequest;clientpub use resources::subscriptions::SubscriptionEstimateParams;clientpub use resources::subscriptions::SubscriptionImportApplyRequest;clientpub use resources::subscriptions::SubscriptionImportPreviewRequest;clientpub use resources::subscriptions::SubscriptionImportSelection;clientpub use resources::subscriptions::SubscriptionInvoiceListParams;clientpub use resources::subscriptions::SubscriptionItemsParams;clientpub use resources::subscriptions::SubscriptionListParams;clientpub use resources::subscriptions::SubscriptionPaymentDetails;clientpub use resources::subscriptions::SubscriptionSyncRequest;clientpub use resources::subscriptions::Subscriptions;clientpub use resources::subscriptions::UpdateSubscriptionRequest;clientpub use resources::three_ds_rules::ThreeDsRuleExecuteRequest;clientpub use resources::three_ds_rules::ThreeDsRules;clientpub use resources::users::ChangeMemberScopeRequest;clientpub use resources::users::ChangePasswordRequest;clientpub use resources::users::CreateInvitationLinkRequest;clientpub use resources::users::DashboardOAuthCompleteRequest;clientpub use resources::users::DashboardOAuthDisconnectRequest;clientpub use resources::users::DashboardOAuthLinkStartRequest;clientpub use resources::users::DashboardOAuthStartRequest;clientpub use resources::users::DeleteUserRoleRequest;clientpub use resources::users::ForgotPasswordRequest;clientpub use resources::users::InviteUsersRequest;clientpub use resources::users::ListRolesParams;clientpub use resources::users::ListUsersInLineageParams;clientpub use resources::users::LoginHistoryParams;clientpub use resources::users::MAX_INVITE_LINK_VALID_DAYS;clientpub use resources::users::PhoneOtpRequest;clientpub use resources::users::PhoneOtpVerifyRequest;clientpub use resources::users::ReInviteUserRequest;clientpub use resources::users::RegisterThroughInvitationLinkRequest;clientpub use resources::users::ResetPasswordRequest;clientpub use resources::users::ResetTeamMemberPasswordRequest;clientpub use resources::users::SetUserPreferenceRequest;clientpub use resources::users::SignInRequest;clientpub use resources::users::SignUpRequest;clientpub use resources::users::SignUpWithMerchantRequest;clientpub use resources::users::SwitchMerchantRequest;clientpub use resources::users::SwitchProfileRequest;clientpub use resources::users::UpdateDashboardTourRequest;clientpub use resources::users::UpdateInvitationLinkRequest;clientpub use resources::users::UpdateMemberExpiryRequest;clientpub use resources::users::UpdateMemberMethodAccessRequest;clientpub use resources::users::UpdateMemberPermissionOverridesRequest;clientpub use resources::users::UpdateRoleConnectorGrantRequest;clientpub use resources::users::UpdateTeamMemberContactsRequest;clientpub use resources::users::UpdateUserDetailsRequest;clientpub use resources::users::UpdateUserRoleRequest;clientpub use resources::users::Users;clientpub use resources::users::VerifyTotpRequest;clientpub use resources::users::WriteTeamMemberNoteRequest;clientpub use resources::verification::ApplePayVerificationRequest;clientpub use resources::verification::Verification;clientpub use resources::whop_resolution_cases::WhopResolutionCaseAction;clientpub use resources::whop_resolution_cases::WhopResolutionCaseActionRequest;clientpub use resources::whop_resolution_cases::WhopResolutionCaseEventsParams;clientpub use resources::whop_resolution_cases::WhopResolutionCaseListParams;clientpub use resources::whop_resolution_cases::WhopResolutionCaseLocator;clientpub use resources::whop_resolution_cases::WhopResolutionCaseStatus;clientpub 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::Moneyand 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.
- resources
client - 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§
- Active
Routing Algorithm - The active routing configuration wrapped in its
{ "algorithm": … }envelope, as merchant-account-based backends return it. - Addon
Group Item Response - An add-on a group offers, with what it costs today.
- Addon
Group Response - A group of optional extras a product offers.
- Address
- A billing or shipping address: street details, phone, and email.
- Address
Details - Street-address details.
- Adjusted
Risk Unavailable - Why a connector has no adjusted assessment.
- Adopt
Subscription Response - The result of taking a subscription already running at its billing processor into DeloPay.
- Airwallex
Apple PayDomain Result - One URL’s outcome from registering Apple Pay domains on an Airwallex account.
- Airwallex
Apple PayDomains Register Response - The per-URL outcomes of registering Apple Pay domains on an Airwallex account.
- Allocation
List Response - Every shop allocation for a merchant.
- Allocation
Response - A shop’s prepaid balance allocation, funded from the host merchant treasury.
- Allocation
Transfer Response - 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.
- AmlEvent
List Response - Every change of a monitored subject’s AML result, newest first.
- AmlMonitoring
- A verification subject’s ongoing AML monitoring.
- Amount
Range - A closed, inclusive band of order values in minor units.
- ApiError
- Structured detail of an API error. Boxed inside
DelopayErrorso the success path of everyResultstays small. - Archived
Shop Response - An archived shop the caller may read.
- Attempt
Vault Usage - How a payment attempt’s card reached the processor: through a card vault, directly, or not recorded.
- Audit
Change - One line of an audited change.
- Audit
Change Item - What one line of an audited change is about.
- Auth
Response - 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.
- Authentication
Response - A standalone 3-D Secure authentication as returned by the API.
- Auto
Recharge Config - Auto-recharge configuration on a
BillingProfileResponse. - Available
Checkout Method - One item a shop may place in its checkout layout.
- Billing
Account Summary - The shop’s billing processor account, as readiness was checked against it.
- Billing
Profile Response - A merchant’s billing profile: prepaid balance, billing status and auto-recharge configuration.
- Billing
Readiness Response - Which active recurring prices can start a subscription on the shop’s billing processor account.
- Billing
Setup Response - The card-setup handshake: everything the frontend needs to render a Stripe card element and confirm the SetupIntent.
- Blocked
Attempt - A payment attempt rejected by the billing suspension gate before any payment was created.
- Blocked
Attempt List Response - A page of blocked payment attempts.
- Built
InRegion Group Response - A built-in (global) region group such as EU / EEA / SEPA / LATAM / APAC.
- Bundle
Item Response - One component of a bundle.
- Buyer
Account Availability - Whether buyers can sign in on this platform, and how.
- Buyer
Account Confirmation - A record confirmed for the signed-in buyer.
- Buyer
Account Invoice - An issued invoice of a confirmed record.
- Buyer
Account Invoice List - One page of the confirmed records’ invoices, newest first.
- Buyer
Account Portal - The shop’s customer portal, opened for a confirmed record.
- Buyer
Account Purchase - One purchase, as a receipt.
- Buyer
Account Purchase Page - One page of the buyer’s purchases, newest first.
- Buyer
Account Refund Request - A refund request of a confirmed record, with the shop’s decision.
- Buyer
Account Refund Request List - One page of the confirmed records’ refund requests, newest first.
- Buyer
Account Session - A signed-in buyer. Send
tokenas theapi-keyheader of buyer account requests: build a separate client with it as the key. - Buyer
Account Session Info - The current session.
- Buyer
Account Shop - A shop the buyer has purchases at.
- Buyer
Account Shop List - The shops the buyer has purchases at.
- Buyer
Account Sign InResponse - What a started sign-in mailed.
- Buyer
Account Subscription - One of the buyer’s subscriptions.
- Buyer
Account Subscription List - One page of the buyer’s subscriptions, newest first.
- Buyer
Blocklist Capabilities Response - Which classes of network an
ip_classentry can be judged by. - Buyer
Blocklist Card Source - The processor a blocked card fingerprint came from.
- Buyer
Blocklist Entry Response - A buyer blocklist entry.
- Buyer
Blocklist Event Response - One payment an entry refused or flagged.
- Buyer
Blocklist Events Response - An entry’s recorded refusals, newest first.
- Buyer
Blocklist From Payment Preview Response - The addresses an “all IPs” block of a payment’s buyer would take.
- Buyer
Blocklist IpCandidate - An address an “all IPs” block of a payment’s buyer would take.
- Buyer
Blocklist IpClass Capability - Whether one class of network can be judged now, and by what.
- Buyer
Blocklist IpClass Finding - A class of network a payment’s address belongs to.
- Buyer
Blocklist IpSnapshot - The addresses an “all IPs” block took.
- Buyer
Blocklist List Response - One page of blocklist entries, newest first.
- Buyer
Blocklist Radar State - Where an entry stands with Stripe Radar.
- Buyer
Case - One refund request or dispute, where it stands and who acts next.
- Buyer
Case Event - One recorded step of a case.
- Buyer
Case List - The buyer’s cases, newest first.
- Buyer
Case Refund - The refund a case led to.
- Buyer
Case Refund Balance - What of a payment can still be refunded.
- Buyer
Case Update - A step of one of the buyer’s cases, shown in the conversation.
- Buyer
Conversation Attachment - A file a message carries, or one uploaded for the next message.
- Buyer
Conversation Attachment Rules - The shop’s rules for files on messages.
- Buyer
Conversation Case Update - A step of a case of the buyer at the shop, shown in the conversation.
- Buyer
Conversation Detail - One conversation and its newest messages, oldest first.
- Buyer
Conversation List - One page of the team’s inbox, the latest message first.
- Buyer
Conversation Message - One message, as the team sees it.
- Buyer
Conversation Note - A team member’s internal note. The buyer never sees one.
- Buyer
Conversation Summary - One conversation in the team’s inbox.
- Buyer
Evidence - A case’s evidence: what may be handed in and by when, the files saved and handed in, and what the reviewer said.
- Buyer
Evidence Deadline - The buyer’s cut-off for evidence.
- Buyer
Evidence Entry - One entry of a case’s evidence history.
- Buyer
Evidence File - A file uploaded for a case.
- Buyer
Evidence Policy - The evidence policy that applied when the evidence was first opened.
- Buyer
Evidence Queue - The shop’s cases with buyer evidence, the nearest target first.
- Buyer
Evidence Review Detail - One case with its evidence, history and files.
- Buyer
Evidence Review Entry - One step of the evidence’s history.
- Buyer
Evidence Review File - A file of the evidence, as the review reads it.
- Buyer
Evidence Rules - What a submission may carry.
- Buyer
Evidence Summary - A case with buyer evidence, as the review queue lists it.
- Buyer
Invoice Link - A customer portal link, returned once when it is issued.
- Buyer
Notice Settings - What the buyer is mailed about, at every shop.
- Buyer
Portal Contact Email Delivery - Where the messages of an email change stand.
- Buyer
Portal Contact Email Outcome - What became of an email change.
- Buyer
Portal Conversation - One of the buyer’s conversations, as the buyer sees it.
- Buyer
Portal Conversation List - The buyer’s conversations, the latest message first.
- Buyer
Portal Invoice - An issued invoice or credit note of the buyer’s.
- Buyer
Portal Invoice Line - One line of an invoice.
- Buyer
Portal Invoice Page - One page of the buyer’s invoices.
- Buyer
Portal Link Page - One page of a customer’s active portal links.
- Buyer
Portal Link Restrictions - Restrictions on a portal link. A field left
Noneimposes no ceiling; no field can grant what the shop’s current portal settings forbid. - Buyer
Portal Link Summary - An issued portal link, without its URL.
- Buyer
Portal Message - One message, as the buyer sees it.
- Buyer
Portal Message Page - The conversation with one shop and its newest messages, oldest first.
- Buyer
Portal Permissions - What a portal grant lets the buyer do.
- Buyer
Portal Plan - A plan the buyer can subscribe to or change to.
- Buyer
Portal Plan Page - One page of plans.
- Buyer
Portal Profile - The buyer’s contact and billing details, and what they may change.
- Buyer
Portal Purchase - One of the buyer’s purchases at the shop.
- Buyer
Portal Purchase Line - One line of a purchase.
- Buyer
Portal Purchase Page - One page of the buyer’s purchases.
- Buyer
Portal Refund Request - A refund request the buyer sent.
- Buyer
Portal Renewal Recovery - A failed renewal the buyer can still pay.
- Buyer
Portal Session - The portal session: the shop’s look and what the grant allows.
- Buyer
Portal Subscription - One of the buyer’s subscriptions at the shop.
- Buyer
Portal Subscription Capabilities - What the buyer may do with a subscription now.
- Buyer
Portal Subscription Page - One page of the buyer’s subscriptions.
- Buyer
Portal Subscription Permissions - Which subscription actions a portal grant allows, each independently.
- Buyer
Refund Request - A buyer’s refund request.
- Buyer
Refund Request List - One page of refund requests, newest first.
- Buyer
Risk Evaluation - One buyer risk evaluation: made at every confirm about to reach a processor.
- Buyer
Risk Evaluations Response - A payment’s buyer risk evaluations, newest first (at most 50). A payment never scored answers an empty list.
- Buyer
Risk Reason - One signal that fired in a buyer risk evaluation.
- Cancel
Subscription Response - Returned by
Subscriptions::cancel. - Candidate
Preview - One checkout judged under a reminder rule.
- Candidate
Preview Response - The shop’s recent checkouts judged under a reminder rule. Nothing was sent.
- Change
Member Scope Response - A team member’s scope after a scope change.
- Checkout
Account Visibility Response - Where a connector account is hidden after a visibility change.
- Checkout
Branding Response - The checkout-branding subset of a shop, as returned by both
CheckoutBranding-gated routes: the read, and the write echoing back what it persisted. - Checkout
Data Params client - Query and locale of
PaymentLinkSession::checkout_data. - Checkout
Data Response - The hosted checkout’s bootstrap payload for a one-time payment, from
GET /payment-link/data/{merchant_id}/{payment_id}. - Checkout
Entries Response - 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. - Checkout
Entry - One checkout entry. Read back from the API and sent again, unchanged or
edited, in
CheckoutEntriesUpdateRequest. - Checkout
Entry Method - One thing a
methodsentry offers: a layout group, one provider’s method, or a general method by capability. - Checkout
Link Resolve Response - The merchant and payment an opaque hosted checkout link opens.
- Checkout
Method Availability - Whether one placeable item reaches the buyer asked about.
- Checkout
Method Child Ref - One child of a placeable item, e.g.
card_network:visa,method:ideal. - Checkout
Method Children Item - What DeloPay confirms beneath one placeable item.
- Checkout
Methods Availability Response - For one buyer (country, amount, currency): which placeable items they are offered and every reason they are not.
- Checkout
Methods Children Response - What DeloPay confirms beneath each item the shop can place: card networks, and the methods or coins a provider’s page offers.
- Checkout
Methods Reset Response - Answer of a checkout-methods reset: the stored layout of one environment was deleted.
- Checkout
Methods Response - A shop’s checkout layout and every item it may place, for one environment.
- Checkout
Payment Method Option - One method a payment can be limited to.
- Checkout
Payment Method Options Response - The methods a payment of the shop can be limited to through
allowed_payment_method_types, in the order its checkout places them. - Checkout
Rail - One rail the buyer can pick, from a vendor catalog.
- Checkout
Reactivation - The checkout a reactivation continues on.
- Checkout
Reactivation Preview - Whether a checkout can be reactivated now, and what it would continue.
- Checkout
Reactivation Record - One earlier reactivation of a checkout.
- Checkout
Recovery Status - 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.
- Checkout
Redirect Rules Test Response - What the tested redirect rules decide for the described buyer, and how each rule fared. Nothing is stored.
- Checkout
Reminder - One message to a buyer about a checkout: an automatic reminder or one sent by hand.
- Checkout
Reminder List - A page of messages to buyers, newest first.
- Checkout
Session client - Buyer-side client for a single hosted-checkout payment, holding both
browser-safe credentials — the merchant’s
PublishableKeyand the payment’sClientSecret. - Checkout
Session Options client - Options shared by both buyer-side clients: which environment to talk to, and the usual transport knobs.
- Checkout
Template Apply Error - Why an apply failed in one shop.
- Checkout
Template Apply Response - What an assign or apply did, or would do on a dry run, in each shop.
- Checkout
Template Blocker - Why a shop was left unchanged by an assign or apply.
- Checkout
Template List Response - The merchant’s checkout templates.
- Checkout
Template OfShop Response - The template a shop is on, if any.
- Checkout
Template Ref - A template by id and name.
- Checkout
Template Response - One checkout template and the shops on it.
- Checkout
Template Shop - One shop on a template, and whether it runs the template’s current settings.
- Checkout
Template Shop Plan - What an assign or apply did, or would do, in one shop.
- Checkout
Theme Conversion Cell - One cell of a conversion report.
- Checkout
Theme Conversion Comparison - A named variant measured against the shop default.
- Checkout
Theme Conversion Filters - The filters a conversion report applied.
- Checkout
Theme Conversion Response - Rendered-to-paid checkout conversion, per appearance variant and segment.
- Checkout
Theme Program Response - A stored checkout theme program: which of a shop’s appearance variants a buyer is shown.
- Client
Secret - A payment’s client secret, from the checkout payload.
- Confirm
Subscription Response - Returned by the create-and-confirm and confirm subscription calls.
- Connector
Buyer Mail Response - A connected provider account’s optional buyer-email preference, for one credential environment.
- Connector
CapBand - One band of a weighted connector cap distribution.
- Connector
CapDistribution - How a ranged connector cap’s value is drawn, in the cap’s own unit.
- Connector
CapDrawn From - The range and distribution a cap’s current limit was drawn from.
- Connector
CapOverride - A connector account’s limits overridden for one project or shop.
- Connector
CapOverride List - Every connector cap override of the merchant.
- Connector
CapOverrides - One connector account’s overrides, and the limits each shop it serves applies.
- Connector
CapShop Limit - The limits one shop applies to a connector account, and where they come from.
- Connector
Capability - One payment method’s state on the processor’s account.
- Connector
Consolidation Response - What folding copies of one provider account into a connector does, or did.
- Connector
Currency Capability - What the provider is known to accept.
- Connector
Currency Conversion - A connector account’s conversion setting, as read.
- Connector
Currency Conversion Setting - A conversion setting: the currency a payment in a currency the connector does not take is converted to.
- Connector
Currency Policy Response - A connector account’s transaction-currency policy.
- Connector
Currency Shop Impact - What a currency-policy write changes in one shop.
- Connector
Health Check - One probe behind a connector’s health verdict.
- Connector
Health Requirements - What a processor is still waiting on before the account is fully enabled.
- Connector
Health Response - What a connector account’s own processor says about it.
- Connector
Response - A merchant connector account as returned by the API.
- Connector
Risk - One connector’s stored risk in one shop.
- Connector
Sell ToEnforcement - Which buyer signals a connector account’s payments can be judged on.
- Connector
Sell ToRestriction - One connector account’s own policy.
- Connector
Settlement Attempt - One attempt’s settlement state on the rail that processed it.
- Connector
Shop Currencies - The currencies a connector account takes in one shop it serves.
- Connector
Shops Response - The shops a connector account serves.
- Connector
Webhook Entry - One webhook endpoint registered with a connector.
- Connector
Webhook List Response - The webhook endpoints registered for one connector.
- Connector
Webhook Register Response - Result of registering a webhook endpoint with a connector.
- Connector
Webhook Sync Response - The result of bringing a connector’s webhook subscriptions up to date.
- Connector
Webhook Sync Result - One endpoint’s outcome from
Connectors::sync_webhook_events. - Consolidation
Account - One account of a consolidation.
- Consolidation
Changes - How many records a consolidation moved from a copy to the kept account.
- Consolidation
Conflict - A setting the accounts of a consolidation disagree on.
- Consolidation
Conflict Value - One value of a conflicting setting.
- Consolidation
Shop - One shop of a consolidated account.
- Create
Invitation Link Response - A newly created team invitation link, with the secret to share.
- Currency
Revenue - Revenue taken in one currency. Amounts are in that currency’s minor units.
- Customer
Identity Entry - One value a customer has been known by, from one origin.
- Customer
Identity History Response - The history of the customers asked for, or a search’s matches.
- Customer
Identity Import Preview Response - What an import would do. Nothing was written.
- Customer
Identity Import Response - An import run and its rows.
- Customer
Identity Import RowResult - One row’s result, in the order the rows were sent.
- Customer
Identity Match - One customer’s matching values in a search answered by customer.
- Customer
Info - Inline customer details, used when creating a customer on-the-fly on a payment.
- Customer
Payment Methods List Response - A customer’s saved payment methods, as
PaymentMethods::list_for_customerreturns them. - Customer
Response - A customer as returned by the API.
- Customer
Shop Bulk Placement Response - Every distinct customer of a bulk placement, in the order of the request.
- Customer
Shop Placement Response - One customer’s placement in a shop.
- DashboardO
Auth Providers Response - 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. - DashboardO
Auth Start Response - Where to send the browser to start an OAuth sign-in or link.
- Dashboard
Tour Access - The user’s current access, and the access they last acknowledged.
- Dashboard
Tour Response - The user’s guided dashboard tour in the session’s scope.
- Dashboard
Tour Scope - The scope a dashboard tour’s progress is kept for, taken from the session.
- Delopay
client - The DeloPay API client.
- Delopay
Builder client - Builder for a
Delopayclient. - Device
Intelligence Setting Response - Whether an account assesses its shop’s checkout devices.
- Device
Signal Response - A payment’s device signal from its checkout’s device assessment.
- Dispute
Bulk Accept Response - Every case’s result of a bulk accept.
- Dispute
Bulk Accept Result - One case’s result of a bulk accept.
- Dispute
Bulk Block Buyer Response - Every case’s result of a bulk buyer block.
- Dispute
Bulk Block Result - One case’s result of a bulk buyer block.
- Dispute
Bulk Blocked Identifier - One buyer identifier a bulk block named, and what became of it.
- Dispute
Bulk Case - A case a bulk action would act on.
- Dispute
Bulk Preview Response - What a bulk action would do. Nothing was changed.
- Dispute
Bulk Skip - A case a bulk action would leave out, and why.
- Dispute
Bulk Total - What the eligible cases add up to in one currency.
- Dispute
Export Record - One row of a dispute export.
- Dispute
Foreign Currency - A dispute amount the processor reported in a foreign currency.
- Dispute
Reconciliation - The settled amount of a foreign-currency dispute.
- Dispute
Refund Association - A refund declared against a dispute, or one the provider reported.
- Dispute
Refund Associations Response - The refunds linked to a dispute. Empty means unknown, not “none”.
- Dispute
Refund Declaration - A refund allocation declared against a dispute.
- Dispute
Response - A dispute as returned by the API.
- Dispute
Workspace Aggregate - Counts over the filtered workspace, without pagination.
- Dispute
Workspace Export - The complete filtered workspace, as one export.
- Dispute
Workspace Filters - The filter values present in the workspace’s scoped case set.
- Dispute
Workspace Response - One page of the workspace.
- Dispute
Workspace Row - One case of the workspace: a native dispute or a case only the provider holds (a PayPal or Whop case, a subscription dispute).
- Effective
Invoice Settings - The settings a shop’s next document is finalised with.
- Epayouts
Methods Response - The e-Payouts rail catalog for one country.
- Ephemeral
KeyResponse - A short-lived key granting a mobile or browser client temporary access to
one customer’s data, as returned by
EphemeralKeys::createandEphemeralKeys::delete. - Event
Delivery Attempt Response - A delivery-attempt shape no route answers.
- Event
Detail Response - One event with the request and response bodies of its delivery.
- Event
List Response - A page of webhook events.
- Event
Manual Trigger Response - What a manual fire did, returned to the operator who fired it.
- Event
Response - A webhook delivery event as returned by the API.
- Export
Envelope - A JSON export: the rows, how many there are, and the filters they were produced under.
- External
Record Capabilities - What this deployment accepts, per kind of object.
- External
Record Create Support - Whether an object with no record yet can be created by a record.
- External
Record Kind Capability - What this deployment accepts for one kind of object.
- External
Record Marker - The marker of a refund, dispute or payment state that was recorded by hand rather than reported by the processor.
- External
Record Response - A recorded out-of-band transition.
- FeeSchedule
Response - A stored fee schedule, as returned by the fee-schedule endpoints.
- FeeStatement
Detail - A statement with its per-connector/currency breakdown.
- FeeStatement
Summary - One generated monthly settlement statement. Every
*_usdamount is USD minor units. - Gateway
Response - A gateway (connector) connection on a shop.
- GetUser
Role Details Response - One role a team member holds, as listed by
Users::list_user_roles. - Hosting
FeeTerm - What a host charged the shops it runs, with the evidence behind the figure.
- Identity
Verification Flow - A provider-side workflow an account can run.
- Identity
Verification Flows Response - The workflows an account can run in one environment.
- Identity
Verification List Response - One page of verifications, newest first.
- Identity
Verification Response - A verification.
- Invitation
Link Preview Response - What a shared team invitation link offers, before joining.
- Invitation
Link Response - A team invitation link: its policy, usage and status.
- Invitation
Link Restrictions - Who may join through a team invitation link: network ranges and a country
rule (
"allow"or"block") over ISO 3166-1 alpha-2 codes. - Invite
Link Response - A pending member’s current invitation link, or why it is not shown.
- Invite
Users Response - The outcome of inviting one team member — one entry per invitee, in the order the invitations were sent.
- Invoice
Credit Note Summary - A credit note issued against an invoice.
- Invoice
Email Delivery - One message about a document to its buyer, its stored PDF attached, and what became of it.
- Invoice
Email Delivery List - Every message about one document to its buyer, newest first.
- Invoice
Line - One line of a document. Amounts are in minor units of the document’s currency.
- Invoice
List - A page of documents.
- Invoice
NoTax Reason - The document-level reason for showing no VAT.
- Invoice
Party - The seller or the buyer on an invoice.
- Invoice
Processor Tax - The order tax a tax service or the processor stated for the source.
- Invoice
Refund Summary - What was refunded of a payment’s invoice, and how much of it is credited.
- Invoice
Settings Response - Invoice settings: the merchant default, or one shop’s override of it.
- Invoice
Share Link - A public link to an issued document’s stored PDF, valid for 7 days.
- Invoice
TaxOutcome - What a line would be taxed at.
- Invoice
TaxReporting - The document’s total tax converted into the reporting currency set in the invoice settings.
- Invoice
TaxRule - One tax rule. A list is ordered; the first enabled rule whose conditions all match decides a line. An empty condition matches everything.
- Invoice
TaxRule Evaluation - The result of a tax-rule dry run. Nothing was written.
- Invoice
TaxRules - A rule list: the merchant’s, or a shop’s.
- Invoice
TaxWarning - Something about the document’s tax worth a look before finalising it.
- IpCountry
Resolution - How this deployment resolves a buyer’s IP country.
- Join
Invitation Link PreAuth Response - A join during sign-in, with the token for the next sign-in step.
- Join
Invitation Link Response - The result of joining through a team invitation link.
- Ledger
Entry - One credit or debit against the prepaid balance.
- Ledger
Response - A page of the balance ledger.
- Lifecycle
Webhook - The subscription snapshot carried by a lifecycle webhook.
- List
Invitation Links Response - The merchant’s team invitation links, newest first.
- List
Response - Generic paginated list envelope:
{ "data": [...], "size"?, "total_count"? }. - Live
Actor - Who made a version.
- Live
Version - One kind of record’s version in one scope.
- Live
Versions Response - The current version of each kind of record asked for.
- Login
History Entry - One row from the authenticated user’s login history.
- Login
History Response - A page of the authenticated user’s login history.
- Managed
Webhook State - The state of the platform’s own webhook at the provider.
- Mandate
Response - A mandate as returned by the API.
- Manual
Email Preview - A message by hand as it would be sent now. Nothing was sent.
- Member
Method Access Response - Which checkout payment methods a member may change in the merchant.
- Member
Permission Area - 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". - Member
Permission Overrides Response - A member’s permission overrides in the merchant.
- Member
Permission Role - A role a member holds, as the permission-overrides read lists it.
- Merchant
Account Response - A merchant account as returned by the API.
- Merchant
Audit Actor Info - Who acted, as a merchant is allowed to see it.
- Merchant
Audit LogEntry - One recorded change on a merchant’s account or one of its shops.
- Merchant
Audit LogExport Record - One row of a merchant audit-log export.
- Merchant
Audit LogList Response - One page of a merchant’s audit log.
- Merchant
Audit Session Info - The sign-in a change was made in.
- Merchant
Audit Setting Change - A change to one setting, as an audit entry records it.
- Merchant
Cost Rule Delete Response - The answer to a cost rule delete.
- Merchant
Cost Rule Response - A recorded merchant cost rule.
- Merchant
Invoice Document - An invoice or credit note a merchant issues to a buyer. Amounts are in
minor units of
currency. - Merchant
Overview Response - High-level merchant overview, as returned by the
projects.overviewendpoint. - Merchant
Overview Stat - One headline figure on the merchant overview, with its period-over-period change.
- Merchant
Risk Response - Every shop’s stored risk for the caller’s merchant.
- Merchant
Routing Algorithm - A full routing configuration, including the algorithm body.
- Message
Template Actor - Who last stored a text.
- Message
Template Detail - One template, its variables and its text in every language.
- Message
Template Html - A text written as a whole HTML document.
- Message
Template Inherited - What applies without a text of the scope’s own.
- Message
Template Language - One language of a template at one scope.
- Message
Template Language Summary - Where one language of a template takes its text from.
- Message
Template Layout - The parts of a text in the branded layout.
- Message
Template List - Every template that can be edited at one scope.
- Message
Template Preview - A template rendered with sample values.
- Message
Template Stored - A text stored at the requested scope.
- Message
Template Summary - One template in a list.
- Message
Template Variable - A variable a template’s text can use.
- Method
Access Option - A checkout payment method and its label.
- Minimal
Role Info - 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.
- Native
Dunning Config Response - The merchant-wide renewal recovery settings.
- Native
Enrollment Abandon Response - Whether an unpaid enrollment was abandoned.
- Native
Enrollment Response - Where a subscription enrollment from the portal stands: its first payment.
- Native
Settlement Account Fees - Account-level fees a provider charges beside the per-transaction ones.
- Native
Settlement FeeComponent - One component of a provider fee, as the provider itemised it.
- Native
Settlement FeeEvidence - One piece of provider fee evidence behind a native calculation.
- Native
Settlement FeeRefresh Response - How far a bounded fee refresh got.
- Native
Settlement FeeTerm - One fee term of a native calculation, with how far it can be trusted.
- Native
Settlement Payout - One transfer recorded in the native-currency ledger.
- Native
Settlement Payout List Response - A page of native-ledger transfers.
- Native
Settlement Preview - A native settlement calculation: a period worked out in its transaction currency, with everything it rests on.
- Native
Settlement Report - A frozen, immutable version of a native settlement calculation.
- Native
Settlement Report List Response - A page of report summaries.
- Native
Settlement Report Summary - One report, without its per-transaction rows.
- Native
Settlement Source - One transaction behind a native settlement calculation.
- Native
Settlement Terms - 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.
- Native
Settlement Totals - The totals of a native settlement calculation, all in minor units of the calculation’s own currency.
- Native
Shop Config Response - A shop’s native enrollment settings, returned by
Subscriptions::native_configandSubscriptions::update_native_config. - Operation
Limit Rule - One persisted operation-limit rule. Amounts are minor units of
currency. - Operation
Limit Usage - 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.
- Operation
Screening Response - A refund’s or payout’s transaction screening.
- Parent
Group Info - One entry in the caller’s permission listing: the role holds the listed
scopesover the resources implied byname. - Pause
Subscription Response - Returned by
Subscriptions::pause. - Payment
Abandon Attempt Response - What abandoning an open attempt did.
- Payment
Agent Signal Response - 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.
- Payment
Attempt Response - A single attempt made on a payment, with its full failure detail. Returned
in the
dataarray ofPayments::list_attempts— useful for surfacing retries across connectors (e.g. “attempt 1 stripe → insufficient_funds, attempt 2 adyen → success”). - Payment
Blockable - What of a payment’s buyer can be blocked.
- Payment
Client Context Entry - One client/device observation captured while the buyer interacted with a payment.
- Payment
Client Context List Response - Every client/device observation recorded for one payment.
- Payment
Connector Settlement Response - Every settlement line the caller may see for one payment.
- Payment
Device Traits - The device traits a payment’s checkout reported.
- Payment
Device Traits Summary - A summary of a payment’s device traits.
- Payment
Early Fraud Warning - A Stripe early fraud warning on a payment.
- Payment
Fraud Review - A Stripe Radar review of a payment.
- Payment
Fraud Signals Response - Stripe’s fraud signals on a payment, and what of its buyer can be blocked.
- Payment
History Actor - Who made a payment history event.
- Payment
IdFormat Config - Custom format for generated payment ids (cloaking), e.g.
ORD-74219807. - Payment
Integration Test Response - A payment’s integration-test mark after it was set.
- Payment
Intent State Metadata - State recorded on a payment beyond its status. Only the post-capture void
is modeled; the rest arrives in
extra. - Payment
Line Refunds - What refunds have credited to one product line, in minor units of the line’s currency.
- Payment
Link Response - A hosted payment link as returned by the API.
- Payment
Link Session client - The client-secret half of a checkout: the
/payment-link/*side channel. - Payment
LogConnector Call - One request sent to the payment provider.
- Payment
LogConnector Call Detail - One provider request of a payment, with its masked request, response and error.
- Payment
LogHeader - One recorded HTTP header.
- Payment
LogIncoming Webhook - One webhook the payment provider sent.
- Payment
LogIncoming Webhook Detail - One provider webhook of a payment, with its masked headers and body.
- Payment
LogOutgoing Attempt - One delivery attempt of a shop webhook, as listed.
- Payment
LogOutgoing Delivery - One delivery attempt of a shop webhook, with what was sent and answered.
- Payment
LogOutgoing Webhook - One webhook sent to the shop, with every delivery attempt.
- Payment
LogOutgoing Webhook Detail - Every delivery attempt of one shop webhook, with request and response.
- Payment
Logs Response - The traffic of a payment, oldest first, without payloads.
- Payment
Method Amount Limits - 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.
- Payment
Method Display Info - Human-facing name and icon for a payment method type, so a custom checkout can render without maintaining a parallel name/logo table.
- Payment
Method List Response - What
PaymentMethods::listreturns: the methods available for a payment, already filtered by country, order value and the merchant’s availability rules. - Payment
Method Presentation Entry - One payment button, heading or group of a presentation.
- Payment
Method Presentation Response - The shop’s payment buttons as the hosted checkout draws them, returned by
PaymentMethods::presentation. - Payment
Method Response - A saved payment method as returned by the API.
- Payment
Post Session Tokens Response - The processor-side session a browser SDK completes.
- Payment
Product Line - One frozen product line of a payment.
- Payment
Product Line Summary - A payment’s first product line and how many it has, for list rows.
- Payment
Product Lines - A payment’s product names and prices, frozen when the payment was created.
- Payment
Reopen Attempt Response - What reopening a switched-away attempt did: the attempt is the payment’s
active one again, and
redirect_urlsends the buyer back to its provider session. - Payment
Response - A payment intent as returned by the API.
- Payment
Routing Decision - How the connector of one attempt was chosen.
- Payment
Routing Decisions Response - How each attempt of a payment was routed.
- Payment
Screening Response - A payment’s transaction screening.
- Payment
Screening Setting Response - Whether an account screens its shop’s payments.
- Payment
Status History Event - 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.
- Payment
Status History Response - The status timeline of a payment, returned by
Payments::list_status_history. - Payments
Delete Response - Outcome of soft-deleting a payment.
- Payout
Export Record - One row of a payout export.
- Payout
Response - A payout as returned by the API.
- Paypal
Dispute Action Record - One action already taken on a case.
- Paypal
Dispute Action Response - What a seller action did.
- Paypal
Dispute Case - One PayPal seller case.
- Paypal
Dispute Document - A document attached to, or downloaded from, a case.
- Paypal
Dispute Import Response - A page of cases imported from PayPal.
- Period
Expense Term - What the period cost the merchant outside the payment rails.
- Permission
Override - A permission level set for one area:
areais a permission group such as"Operations",levelone of"hidden","read","edit","write". - Phone
Details - A phone number split into national number + country code.
- Phone
OtpResponse - The result of sending a one-time code to a phone number.
- Phone
OtpVerify Response - The result of verifying a one-time code sent to a phone number.
- Poll
Status Response - Status of an asynchronous operation, as returned by
Poll::status. - Post
Capture Void Response - The state of a post-capture void.
- Post
Session Tokens Request client - Body of
CheckoutSession::post_session_tokens, without the client secret the session attaches. - Presentation
Action - What selecting a presentation entry does.
- Presentation
Cache Policy - How long a presentation may be reused. Also sent as
Cache-Control. - Presentation
Child - A descriptive badge of a presentation entry: a card network, a method or a crypto asset it contains.
- Presentation
Context - The buyer context a presentation was resolved for. A field left
Nonewas not applied. - Presentation
Crypto Network - A crypto network a presentation child is offered on.
- Presentation
Icon - An entry’s or child’s artwork: one of the built-in glyphs
(
kind == "builtin", named bykey) or an SVG document (kind == "svg", indata_uri). - Prevention
Account - One business account the provider holds under a connection.
- Prevention
Answer - What DeloPay answered the provider’s latest delivery of an alert.
- Prevention
Case - One alert and what DeloPay knows of its payment.
- Prevention
Case Detail - A case with its references and history.
- Prevention
Case Event - One state of a case DeloPay observed, in the provider’s order.
- Prevention
Case List - A page of cases.
- Prevention
Connection - A connected provider account. Carries no key.
- Prevention
Connection List - The merchant’s connections.
- Prevention
Connection Summary - A connection’s state beside a case list.
- Prevention
Refund Action - What a refund rule did about one alert: a refund it made, or a payment it found already refunded. One per payment.
- Prevention
Refund Action List - A page of refund rule actions.
- Prevention
Refund Action Summary - The refund rule’s action on a case’s payment, as the case shows it.
- Prevention
Refund Limit - The most a refund rule refunds for one alert in one currency.
- Prevention
Refund Preview - What a rule would do with the account’s open alerts now.
- Prevention
Refund Preview Item - What a rule would do with one open alert.
- Prevention
Refund Rule - A merchant’s opt-in refund rule for one prevention connector account and environment. Off unless the merchant turns it on in the dashboard.
- Prevention
Refund Rule List - Every connected account’s refund rule.
- Prevention
Sync Health - How current a connection’s cases are.
- Price
Billing Readiness - One recurring price and whether it can start a subscription.
- Processor
Cost Bucket - A per-connector processor cost bucket, with a USD conversion.
- Processor
Cost Estimate Basis - The fee schedule an estimated processor cost was priced from.
- Processor
Cost Event Bucket - Signed refund or dispute fees of one connector and currency.
- Processor
Cost Event Source - One refund or dispute, with the rail’s own fee movements for it.
- Processor
Cost Event Term - Refund or dispute processor fees in one reporting period.
- Processor
Cost Events Response - A page of refund and dispute cost evidence.
- Processor
Cost Method Bucket - Payment fees grouped by the method recorded when each payment settled.
- Processor
Cost Native Bucket - One bucket of processor cost in the rail’s own currency, keyed by connector, ownership, cost currency and cost exponent together.
- Processor
Cost Period Bucket - 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. - Processor
Cost Period Response - What a period’s payments cost at the rails, per shop, connector and method.
- Processor
Cost Schedule Response - A recorded processor cost schedule.
- Processor
FeeMovement - One fee movement the rail reported.
- Processor
Visibility Exception - A processor a role’s payment-data policy singles out.
- Product
Alias Response - A name a product goes by.
- Product
Category List Response - The shop’s categories, in order.
- Product
Category Response - A shop category.
- Product
Connector Reference Response - A connected account’s product or price, tied to a catalogue product.
- Product
Delete Response - What a delete with provider clean-up did.
- Product
Image Upload Response - An uploaded product image.
- Product
Import Capabilities - What the import can and cannot read from a provider, so an
unchangedverdict is read for what it covers. - Product
Import Counts - What an import preview found, or what an apply did.
- Product
Import Failure - One item an import apply could not bring over.
- Product
Import Item Preview - How one provider item relates to the catalogue.
- Product
Import Preview Response - What a connected account’s catalogue holds, and how each item relates to the shop’s catalogue.
- Product
Import Price Preview - How one provider price relates to the catalogue.
- Product
Import RunList Response - The shop’s past imports from one connected account, newest first.
- Product
Import RunResponse - What one import did.
- Product
List Response - One page of a shop’s catalogue, newest first.
- Product
Price Response - A price as the catalogue reports it.
- Product
Provider Create Response - What a create at a provider did, or the plan it would carry out.
- Product
Provider Link - The product’s copy at one connected account.
- Product
Provider Push Response - What a push to a provider did.
- Product
Provider Sync Batch Response ProductProviderSyncResponsefor several products.- Product
Provider Sync Response - How a product compares with its copy at every account it is tied to.
- Product
Resolve Response - The product a name or a connector’s id resolves to. Archived products resolve too, so a payment that references one is still attributed.
- Product
Response - A product as the catalogue reports it, prices and identity included.
- Product
Sales ByCurrency - A product’s sales in one currency and the refunds credited back to it.
- Product
Sales Response - What a product sold in a window, per currency.
- Profile
Acquirer Response - 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.
- Profile
Default Routing Config - Per-profile default fallback routing.
- Profile
Logo Upload Response - Result of uploading a shop logo.
- Profile
Response - A shop (business profile) as returned by the API.
- Profit
Cost Term - One merchant-side cost term (cost of goods, partner shares).
amount_usdis a lower bound wheneverincompleteorfx_incompleteis set; a gap is never a zero. - Project
Direct Stats - The figures of a project’s own shops, without its sub-projects.
- Project
Limits Response - How deep a merchant may nest projects, and how deep it does.
- Project
Path Entry - One project on the way from the top level to a project.
- Project
Response - A project — an optional grouping layer that contains one or more shops.
- Project
Sell ToRestriction - One project’s own policy.
- Project
Stats - Order and revenue figures for one project, plus its shops.
- Project
Stats Response - Aggregate payment statistics across all of a merchant’s projects, as
returned by the
projects.statsendpoint. - Provider
Account - A connected account of the shop the catalogue can work with.
- Provider
Account List Response - The shop’s connected accounts the catalogue works with.
- Provider
Archive Outcome - What an archive did at one connected account.
- Provider
Capabilities - What the catalogue can do with one connected account.
- Provider
Cleanup - A provider clean-up still to be carried out: one that failed, or one a
delete recorded and never reached (
attempted_atempty). - Provider
Cleanup List Response - Provider clean-ups still to be carried out.
- Provider
Cost - What a provider charged, or is estimated to charge.
- Provider
Create Plan - What a create writes at the provider.
- Provider
Create Price - A catalogue price a create would carry to the provider.
- Provider
Created Price - One price of a create: the provider’s id, or why it was not created.
- Provider
Price Terms - A price’s terms as the catalogue or the provider states them.
- Provider
Push Step - One provider write a push made.
- Provider
Sync Difference - One difference between the catalogue and the provider.
- Provider
Unsupported Price - A catalogue price the provider cannot hold, and why.
- Provider
Webhook Capabilities - Which webhook changes a provider allows.
- Provider
Webhook Create Response - A webhook created at the provider.
- Provider
Webhook Delete Result - What deleting one webhook at the provider did.
- Provider
Webhook Endpoint - One webhook as the provider lists it.
- Provider
Webhook List Response - Every webhook the provider lists for a connector’s credentials in one environment.
- Provider
Webhook Replace Preview Response - What replacing every webhook with the platform’s own would delete and keep. Nothing is changed.
- Provider
Webhook Replace Response - What replacing every webhook with the platform’s own did.
- PspImport
Account - A connector account an import can read.
- PspImport
Capability - What a connector account can provide for one record type.
- PspImport
Counts - How many records an import or one of its sources handled.
- PspImport
Issue - A record an import left out or could not record.
- PspImport
Issues Response - One page of an import’s issues.
- PspImport
Latest Response - The newest import in an environment.
- PspImport
RunResponse - An import run.
- PspImport
Source Progress - One connector account and record type of an import.
- PspImport
Sources Response - Every connector account an import can read in an environment.
- Public
Branding - The deployment’s branding as every page may read it.
- Publishable
Key - A publishable, browser-safe API key (
pk_prd_…/pk_snd_…). - Radar
Item Counts - How many items of a connection are in each sync state.
- Radar
Sync Connection - An entry’s sync to one Stripe connection.
- Radar
Sync Item - One identifier’s sync to one Radar value list.
- Radar
Sync Settings List Response - The Radar sync settings of every Stripe connection the caller sees.
- Radar
Sync Settings Response - One Stripe connection’s Radar sync settings.
- Radar
Value List Info - A Radar value list a Stripe connection syncs to.
- ReInvite
User Response - The outcome of resending an invitation.
- Record
Checkout Event Response - Receipt for a recorded buyer-side checkout event.
- Recovery
Codes Response - A freshly generated set of recovery codes. Generating a new set invalidates the previous one.
- Recovery
Payment Notice - The recovery payment announced on a lifecycle webhook.
- Refund
Bulk Block Buyer Response - Every refund’s result of a bulk buyer block.
- Refund
Bulk Block Preview Response - What a bulk block of refunds’ buyers would name. Nothing was changed.
- Refund
Bulk Block Result - One refund’s result of a bulk buyer block.
- Refund
Bulk Buyer - One selected refund’s buyer, as a block would name them.
- Refund
Bulk Identifier - One identifier a block of a refund’s buyer would name.
- Refund
Export Record - One row of a refund export.
- Refund
Line Credit - What a refund credited to one product line.
- Refund
Response - A refund as returned by the API.
- Region
Countries Response - The country membership of a region.
- Region
Response - A custom region (named country group) scoped to a shop.
- Register
Through Invitation Link Response - The result of making an account through a team invitation link.
- Renewal
Recovery Payment - The payment a buyer can make to recover a failed renewal.
- Renewal
Retry State - The renewal retries of a subscription’s current billing cycle.
- Replay
Expiry - When and why a checkout recording was removed.
- Replay
Ingest Request client - Body of
CheckoutSession::store_replay_slice, without the client secret the session attaches. - Replay
Ingest Response - What the recorder is told about one stored slice.
- Replay
Playback Response - The manifest of a payment’s stored checkout recording, answered when a playback is opened.
- Replay
Slice Info - One slice named in a playback manifest.
- Replay
Slice Response - One slice’s recorded events, read against an open playback.
- Reset
Team Member Password Response - A team member’s temporary password, returned once by a reset.
- Response
Payment Method Types - One payment method type offered for a payment, with what is needed to render it.
- Response
Payment Methods Enabled - The method types offered under one broad payment method (
card,wallet, …). - Resume
Subscription Response - Returned by
Subscriptions::resume. - Retrieve
Payment Link Response - One payment link, as
PaymentLinks::retrieveanswers it. - Risk
Adjustments - One merchant, project or shop’s adjustments of how its risk is scored.
- Risk
Bands - Where each band begins on the 0 to 100 index. The three values must ascend and stay within 100.
- Risk
Card Testing Incident - A card-testing burst detected on a connector.
- Risk
Component Adjustment - A change to one component’s rule. A part left
Nonekeeps the reference model’s value, which may differ per connector. - Risk
Tuning Estimate - A band and index estimated from stored evidence.
- Risk
Tuning Preview Connector - The estimate for one shop on one connector.
- Risk
Tuning Preview Response - What a change to one scope’s tuning would do. Nothing was stored or scored.
- Risk
Tuning Preview Shop - The estimates for one shop a change reaches.
- Risk
Tuning Response - One scope’s risk tuning: what it sets, what applies there and where each part comes from, and DeloPay’s reference beside it.
- Risk
Window Band Overrides - One window’s band boundaries, overridden together. A window left
Noneinherits its complete boundary set. - Role
Connector Grant Entry - One connector account in a role’s grant.
- Role
Connector Grant Response - The connector accounts a role may see.
- Role
Entity Ref - An entity a role is held on: its ID and, where it has one, its name.
- Role
Payment Visibility Policy - A role’s explicit payment-data policy. Each visibility is
"none"or"read". - Routable
Connector Choice - A connector the router may pick.
- Routing
Config Delete Response - The outcome of soft-deleting a static routing configuration.
- Routing
Config History Response - One page of a routing configuration’s timeline, oldest first.
- Routing
Config Version - One content window in a routing configuration’s history.
- Routing
Connector Cap - One connector account’s lifetime payment cap for a shop.
- Routing
Connector CapReset - What resetting one limit’s usage cleared.
- Routing
Connector CapSchedule - A shop’s complete dated limit schedule. Gaps between entries use the ordinary configured caps.
- Routing
Connector CapSchedule Entry - One dated limit for an account and unit, applied without restarting usage.
- Routing
Connector Caps - A shop’s connector caps.
- Routing
Connector Payment Range - One connector account’s per-payment amount range for a shop.
- Routing
Decision Attempt - One attempt of a payment and the routing decision recorded for it.
- Routing
Decision Candidate - A connector a routing decision considered.
- Routing
Decision Volume Counter - A volume counter a routing decision read.
- Routing
Decision Volume Split Entry - One entry of a volume split a routing decision drew from.
- Routing
Dictionary - Every routing configuration for a merchant, plus which one is active.
- Routing
Dictionary Record - 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.
- Routing
Volume Counter - One budget a routing program compares against.
- Routing
Volume Counters - The live
routing_volumecounters behind a shop’s active advanced program. - Sales
Revenue Term - What a merchant that hosts nobody sold in the period.
- Secret
Key - A secret API key (
prd_…for production,snd_…for sandbox). - Sell
ToRestriction Capabilities Response - Which checks each payment path performs, and how a buyer’s country is resolved.
- Sell
ToRestriction Decision Response - One refusal of a payment by a sell-to policy.
- Sell
ToRestriction Decisions Response - Why a payment was refused by sell-to policies.
- Sell
ToRestriction Policy - A sell-to policy.
- Sell
ToRestriction Rail Capability - Which checks one payment path performs.
- Sell
ToRestrictions Response - The merchant-wide policy and every shop’s effective policy.
- Send
Test Message Response - Where a test message was sent.
- Setting
Actor - The person or credential that last changed a value.
- Setting
Entry - One setting at the requested scope.
- Settings
Response - Every setting at one scope.
- Settlement
Advance List Response - The advances recorded against one shop-month.
- Settlement
Backfill Response - Outcome of enqueuing a settlement-line backfill.
- Settlement
Bucket - One per-connector/currency rollup inside a statement or the current-period
view. Amounts are native minor units of
currency. - Settlement
Cost Response - What a period’s payments cost, and what was left over. All
*_usdfigures are USD minor units. - Settlement
Current Response - Live rollup of the current (not yet statemented) period.
- Settlement
Line - One settled payment attempt. Amounts are native minor units of
currency. - Settlement
Line List Response - A page of settlement lines.
- Settlement
Overview Response - Per-shop settlement rollup for the host merchant.
- Settlement
Statement List Response - A page of generated statements, newest first.
- Shop
Archive Response - A shop’s navigation state after an archive or restore.
- Shop
FeeConfig Entry - One fee schedule that currently applies to a shop.
- Shop
FeeConfig Response - The fee schedules that currently apply to a shop.
- Shop
Label Delete Response - Outcome of deleting a shop label.
- Shop
Label Response - A label of the merchant and the shops that carry it.
- Shop
Label Summary - One label, as a shop carries it.
- Shop
Labels Response - The labels one shop carries.
- Shop
Payments Switch Response - A shop’s payments switch after it was set.
- Shop
Response - A shop (business profile) as returned by the API.
- Shop
Risk Response - One shop’s stored risk across the connectors it processes on.
- Shop
Sell ToRestriction - One shop’s effective policy and where it comes from.
- Shop
Settlement Overview - One shop’s row in the host merchant’s settlement overview.
- Shop
Stats - Order and revenue figures for one shop, as they appear nested inside
ProjectStatsResponse. - Shop
Stats Response - Stats for one shop, as returned by the
shops.statsendpoint. - Shop
Visibility Response - Whether a shop’s owner may open their own settlement figures.
- Statement
Adjustment - One manual position the host added to a statement.
- Statement
Adjustment List Response - The manual adjustments recorded on a statement.
- Statement
Advance - A transfer recorded against a shop’s month before that month’s statement exists.
- Statement
Payout - One recorded transfer against a monthly statement.
- Statement
Payout List Response - Every transfer recorded against one statement.
- Stripe
Payment Method Domain Result - Outcome of registering one URL as a Stripe payment method domain.
- Stripe
Payment Method Domains Register Response - The per-URL outcomes of registering Stripe payment method domains.
- Subject
AmlMonitoring - A subject’s verification under ongoing AML monitoring.
- Subject
Verification - A subject’s latest verification.
- Subject
Verification Response - A subject’s latest verification and AML monitoring in one environment.
- Subscription
Billing Processor Response - The billing processor a shop’s subscriptions run on.
- Subscription
Capabilities - Which lifecycle actions an existing subscription supports.
- Subscription
Checkout Response - The hosted checkout’s bootstrap payload for a subscription, from
GET /subscriptions/data/{merchant_id}/{subscription_id}. - Subscription
Data Params client - Query and locale of
PaymentLinkSession::subscription_data. - Subscription
Estimate Response - Cost estimate for a subscription before creating it, as returned by
Subscriptions::estimate. - Subscription
Export Record - One row of a subscription export.
- Subscription
Import Apply Response - The results of an import, one per selection in request order.
- Subscription
Import Capabilities - What the import can do on one billing processor.
- Subscription
Import Counts - How many listed subscriptions fell into each classification.
- Subscription
Import Item - One subscription the processor holds, as the import classifies it.
- Subscription
Import Preview Response - What a billing account holds at its processor, classified against DeloPay’s subscriptions.
- Subscription
Import Result - One selection’s import result.
- Subscription
Invoice - A single invoice raised for one billing cycle of a subscription.
- Subscription
Invoice List Response - One subscription’s billing history, newest cycle first.
- Subscription
Item - A subscription item (plan or addon) with its available prices, as returned
by
Subscriptions::items. - Subscription
Item Price - A purchasable price option for a subscription item (plan or addon).
- Subscription
Line Item - A single line of a subscription cost estimate.
- Subscription
Method Option - One method a buyer may pick for a subscription waiting for the choice.
- Subscription
Method Options Response - 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.
- Subscription
Payment Data - Payment leg attached to a subscription’s current billing cycle, present once a charge has been attempted.
- Subscription
Payment Link - One resolved payment → subscription link.
- Subscription
Payment Lookup Response - The resolved subset of a batch of payment ids.
- Subscription
Provider Read - One read of a subscription at its billing processor.
- Subscription
Response - A subscription, as returned by create / retrieve / update / list.
- Subscription
Return Session client - Reads the status a buyer coming back from the processor’s checkout may
see, authenticated with the return token (
rt) the return URL carried. - Subscription
Return Status Response - What a buyer coming back from the processor’s checkout may read about their subscription with the return token alone.
- Subscription
Sync Response - The results of a batch sync, one per requested ID in request order.
- Subscription
Sync Result - One subscription’s sync result.
- Surcharge
Rule Response - A stored surcharge program: the structured configuration plus its version metadata and any server-side advisories.
- Team
Member Contact Channel - One further contact channel of a team member.
- Team
Member Contact Profile Response - A member’s supplied contacts and the internal notes kept about them.
- Team
Member Contacts - A team member’s supplied contacts.
- Team
Member Details Response - One member of the caller’s merchant, with the person fields the member list omits.
- Team
Member Note - One internal note about a team member.
- Team
Member Note Actor - The user who wrote or edited a team-member note.
- Test
Email Response - The outcome of a test reminder sent to the signed-in user’s own address.
- Tier
Summary - The merchant’s currently-locked platform-fee volume tier.
- Token
Response - A freshly minted single-purpose token, returned by the email-token exchange, the two-factor terminate step and employee impersonation.
- Topup
Response - The result of a manual balance top-up.
- Totp
Response - The result of starting TOTP setup.
- Totp
Secret - The TOTP enrolment material: the shared secret and the
otpauth://URI a dashboard renders as a QR code. - Tour
Access Group - One permission area and the scopes held over it.
- Tour
Active - The dashboard tour in progress.
- Tour
Baseline - A dashboard-tour baseline.
- Tour
Progress - A user’s progress through the dashboard tour in one scope.
- Transaction
Export Record - One row of a transaction export.
- Transaction
Line Export Record - 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. - Update
Member Expiry Response - A team member’s access expiry after an update.
- User
InLineage - One member of the caller’s lineage.
- User
Preference Response - One of the signed-in user’s own preferences. A
Nonevalue means no preference is saved: use your defaults. - User
Response - The authenticated user’s own details, as returned by the profile, update and password-change endpoints.
- User
Session Entry - One currently-active dashboard session — a single minted login JWT.
- User
Session List Response - The authenticated user’s active sessions.
- User
Session Revoke Response - The result of disconnecting one of the user’s sessions.
- Vault
Check - One vault configuration check.
- Vault
Collect Session Response - What a checkout page needs to stand up a VGS Collect form.
- Vault
Outage - One shop whose vault account refuses the API.
- Vault
Outages Response - The shops whose switched-on vault account has stopped working.
- Vault
Payment Method Request client - Body for
PaymentLinkSession::register_vault_payment_method. - Vault
Payment Method Response - The registered vault card, plus the one-shot token that pays with it.
- Vault
Processor Hiding - Whether one processor’s card payments can be hidden behind a vault.
- Vault
Route Apply Verification - What a read-back after writing vault routes established.
- Vault
Route Change - One route change of a vault route preview.
- Vault
Route Ids - The ids of a vault’s collect and reveal routes.
- Vault
Route Warning - A non-blocking advisory about vault routes.
- Vault
Routes Apply Response - The result of writing a vault connector’s routes.
- Vault
Routes Preview Response - The route document a vault connector should have, diffed against what exists. Nothing is written.
- Vault
Switch OffResponse - A shop after its card vault was switched off.
- Vault
Verification Response - The configuration checks of a vault connector account.
- Verification
Check - One check of a verification and its result.
- Webhook
Address Constraints - The limits a callback address must keep to.
- Webhook
Address Environment - The callback address of one environment.
- Webhook
Address Format - The identifier format of an
anonymouscallback address. - Webhook
Address Preview Group - One credential group a proposed callback address affects.
- Webhook
Address Preview Response - The result of validating a proposed callback address. Nothing is saved.
- Webhook
Address Rate Limit - How many callback-address changes remain.
- Webhook
Address Response - The callback addresses of a merchant’s accounts at one payment provider.
- Webhook
Address Validation Error - Why a proposed callback address is not valid.
- Webhook
Content - The tagged payload of a webhook event:
{ "type": …, "object": … }. - Webhook
Event - A parsed, signature-verified DeloPay webhook event.
- Whop
Apple PayDomain Result - One URL’s outcome in
WhopApplePayDomainsRegisterResponse. - Whop
Apple PayDomains Register Response - The per-URL outcomes of registering Apple Pay domains on a Whop account.
- Whop
Resolution Case - A Whop resolution case as Whop reports it now.
- Whop
Resolution Case Action Response - The result of an action on a case.
- Whop
Resolution Case Attachment - A file attached to a case event.
- Whop
Resolution Case Event - One event of a case’s timeline.
- Whop
Resolution Case Event List - One page of a case’s timeline, newest first.
- Whop
Resolution Case List - One page of Whop cases, newest first.
Enums§
- Active
Routing Config - What the active-routing endpoint returns: either the merchant-account envelope, or a list of profile-based records.
- Authentication
Type - Whether to request 3-D Secure authentication.
- Bundle
Pricing - How a bundle is priced.
- Capture
Method - How and when funds are captured.
- Customer
Identity Import Outcome - What became of one import row.
- Customer
Shop Placement Outcome - What placing a customer in a shop did.
- Default
Profile Routing - What the default-profile-routing endpoint returns: either a flat connector list (merchant-wide default) or one entry per profile.
- Delopay
Error - Everything that can go wrong talking to DeloPay.
- FeeOwner
- Who owns a fee schedule or fee-rule program.
- LogEvent
client - One thing worth logging, handed to a
DelopayLogger. - Message
Template Content - 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.
- Price
Billing State - Whether one recurring price can start a subscription on the shop’s billing processor account, in the environment the account is in now.
- Product
Alias Kind - Whether a name is the product’s current name or another name it goes by.
- Product
Import Classification - How a provider item relates to the catalogue right now.
- Product
Import Price State - How one provider price relates to the catalogue.
- Product
Kind - What a catalogue product is sold as.
- Product
Mapping Mode - How a connected account’s product or price was tied to a catalogue product.
- Product
Match - What a product was resolved by.
- Product
Price Interval - The unit a recurring price bills in, and the unit a trial is measured in.
- Product
Price TaxBehavior - Whether a price’s amount includes tax or has it added on top by the billing processor.
- Product
Status - Whether a product, a price or a category is still in use.
- Provider
Archive Action - What to do at one connected account when a product is deleted or archived there.
- Provider
Archive Mode - How a provider can be cleaned up when a product is deleted.
- Provider
Archive Status - What an archive did at one connected account.
- Provider
Environment - A connected account’s environment.
- Provider
Push Action - What a push to the provider does about one difference.
- Provider
Sync Field - A field compared between the catalogue and the provider.
- Provider
Sync Status - How a connected account’s copy of a product compares with the catalogue.
- Provider
Unavailable Reason - Why the catalogue cannot work with a connected account right now.
- Refund
Type - Refund processing type.
- Setup
Future Usage - Whether to save the payment method for future use.
- Subscription
Checkout Method client - A payment method a buyer can pick in the hosted subscription checkout.
- Surcharge
Condition - 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:2for EUR,0for JPY,3for KWD.
Type Aliases§
- Allocation
Status - Status of a per-shop balance allocation, e.g.
"active","suspended". - Authentication
Status - 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. - Billing
Status - 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. - Block
Reason - Why a payment attempt was rejected by the billing gate:
"billing_suspended","billing_setup_incomplete", or"allocation_suspended". - Cancel
Mode Outcome - Whether a cancellation was performed the way it was asked for.
- Connector
Health State - The overall health verdict for a connector account:
"healthy","degraded","cannot_accept_payments"or"unknown". - Connector
Health Unknown Reason - Why a connector’s health could not be established, present exactly when the
state is
"unknown". - Connector
Ownership - Who owns the connector a settlement line ran through:
"host","shop", or"unknown"for lines frozen before ownership tracking existed. - Connector
Settlement Status - What the payment’s rail says about settling one attempt.
- Delopay
Logger client - A sink for
LogEvents, installed withDelopayBuilder::logger. - Dispute
Outcome Reporting - Whether a processor tells DeloPay how a dispute ended.
- Event
Type - The event types the API raises.
- Expense
Allocation - How a period expense that only partly overlaps the report window is
counted:
"pro_rata_days"or"not_applied". - Failure
Substatus - Why a payment failed or was declined, e.g.
"insufficient_funds". A substatus this crate does not know reads asdeclined_other/failed_otheron the API side; here it arrives verbatim. - Invoice
Amount State - Whether an invoice’s
amountis a figure at all. - Invoice
Auto Issue - Whether a paid payment or subscription cycle gets its invoice without a
request:
off,draft(a draft to check and finalise by hand) orfinalize(issued; a document that cannot be finalised stays a draft). - Invoice
Buyer Type - Which buyers a tax rule applies to:
any,business(a VAT id or a tax number),vat_registered(a VAT id) orconsumer(neither). - Invoice
Document Status - Where a document is in its life:
draft,issuedorvoided. - Invoice
Email Delivery Status - What the mail provider reported about a message after accepting it:
bouncedorcomplained. - Invoice
Email Origin - Why a message to the buyer was queued:
automatic(the shop mails every invoice it issues) ormanual(a send by hand). - Invoice
Email Status - What became of a message to the buyer:
queued,sending,sent,failedorskipped. - Invoice
Kind invoiceorcredit_note.- Invoice
Line Role - What a line is:
product,addon,bundle,component,surchargeorshipping.surchargeis the difference between what the buyer was charged and what the sold lines add up to. - Invoice
Line TaxSource - How a line’s tax was decided:
processor,reported,rule,defaultormanual. - Invoice
Locale - The document’s language:
en,de,fr,es,it,nl,ptorpl. - Invoice
Locale Mode - How a document’s language is chosen:
fixed(alwayslocale) orbuyer_country(the buyer country’s language where supported). - Invoice
NoTax Rule Reason - Why a tax rule shows no tax:
reverse_charge,exempt,export,outside_scopeorsmall_business. - Invoice
Processor TaxMode - Whether a stated order tax decides the lines’ tax:
prefer_processororignore. - Invoice
Setting Source - Where an effective setting or a rule list came from:
shop,merchantordefault. - Invoice
Source Kind - What a document is for:
paymentorsubscription_cycle. - Invoice
TaxMode vatshows VAT at the default rate on gross prices;no_vatshows none and needs a reason.- Invoice
TaxRule Kind - What a tax rule decides:
rate(tax atrate_bp) orno_tax. - Manual
Trigger Event Type - The event types a manual fire accepts: the twelve payment and refund types
listed on
EventType. - Margin
Quality - How much weight
SettlementCostResponse::margin_usdcarries:"exact","upper_bound"(the real figure is this or lower) or"unknown"(no figure is published). - Merchant
Audit Actor Kind - The parties a merchant can see in their own log.
- Merchant
Audit Impersonation Kind - Which relationship an impersonated change was made under.
- Merchant
Cost Rule Category - What a cost rule records:
"goods","partner_share"or"other". - Native
Minor - Native settlement money: minor units as a decimal string.
- Native
Recovery Mode - 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). - Native
Settlement Quality - Whether a native settlement calculation is final or still provisional:
"complete"or"provisional". - Operation
Limit Unlimited Reason - Why no limit applies to the caller for an operation:
"no_rule"or"admin_exempt". - Parent
Group - A top-level permission group recognized by the Delopay API, e.g.
"Operations","Connectors","Users". A string so new groups do not break deserialization. - Payment
IdStyle - Charset used for the random body of a custom-format payment ID, e.g.
"numeric","alphanumeric","alphanumeric_uppercase". - Paypal
Dispute Action - A seller action PayPal offers on a case.
- Permission
Scope - A permission scope:
"Read"allows viewing,"Write"is required for any mutation. - Processor
Cost Basis - What the figures of a cost rollup rest on:
"reported"(observations from the rails),"estimated"(configured rates),"mixed"or"none". - Project
Depth Source - Where a merchant’s project depth limit comes from:
"default","platform"or"merchant_override". - Result
- Convenient result alias used throughout the crate.
- Revenue
Basis - 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. - Routing
Approach - The category of routing decision behind an attempt — never the rule that fired.
- Settlement
Payout Status - Payout progress of a settlement statement.
- Subscription
Import Classification - How a processor subscription relates to DeloPay:
"new","needs_customer","held","ended"or"not_adoptable". - Subscription
Import Outcome - What taking one subscription over did:
"adopted","already_held"or"failed". - Subscription
Import Reason - Why the import cannot list, offer or take over a subscription, as a code
to word: e.g.
"listing_unsupported","adoption_disabled". - Subscription
Sync Outcome - What reading one subscription back from its processor did:
"updated","unchanged","undated","not_at_processor","not_found"or"failed". - Surcharge
Direction - Whether an adjustment adds to or takes off the buyer’s total:
"surcharge"or"discount". - Suspension
Source - What caused a suspension:
"auto_recharge"(automatic, lifted by a successful top-up) or"admin"(sticky, lifted only by an admin). - Term
Bearer - Whose money a term of the cost model comes out of:
"merchant"or"shop_owner". - Token
Purpose - 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. - Transaction
Type - 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. - Webhook
Delivery Attempt - What kind of delivery a webhook row records:
"initial_attempt","automatic_retry","manual_retry"or"manual_trigger".