delopay 0.3.0

Official Rust SDK for the DeloPay payments API
Documentation
//! Official Rust SDK for the [DeloPay](https://delopay.net) 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.
//!
//! ```no_run
//! # #[cfg(feature = "client")]
//! # fn main() {
//! use delopay::{Delopay, PaymentCreateRequest};
//!
//! # async fn run() -> delopay::Result<()> {
//! // 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}");
//! # Ok(())
//! # }
//! # }
//! # #[cfg(not(feature = "client"))]
//! # fn main() {}
//! ```
//!
//! # Cargo features
//!
//! - `client` *(default)* — the async HTTP client: `Delopay`, the `resources`
//!   module, retries. Pulls in `hyper`, `hyper-rustls` and `tokio`.
//!
//! With `default-features = false` the crate builds webhook verification and
//! the wire models only, over a pure-Rust dependency tree that needs no C
//! toolchain:
//!
//! ```toml
//! delopay = { version = "0.2", default-features = false }
//! ```
//!
//! # Webhooks
//!
//! Verify the raw request body before trusting it — never parse the JSON first:
//!
//! ```no_run
//! use delopay::webhooks;
//!
//! # fn handle(raw_body: &[u8], sig_header: &str, secret: &str) -> delopay::Result<()> {
//! 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);
//!     }
//! }
//! # Ok(())
//! # }
//! ```

#![forbid(unsafe_code)]
#![warn(missing_debug_implementations)]
#![cfg_attr(docsrs, feature(doc_cfg))]

mod core;

#[cfg(feature = "client")]
mod http;
#[cfg(feature = "client")]
pub mod resources;

/// Checkout branding: encode/decode the hosted checkout's appearance
/// configuration, plus the sanitizer for merchant-supplied custom CSS.
///
/// In `core`, so it is available in the `default-features = false` build.
pub use core::branding;
pub use core::error::{ApiError, DelopayError, Result};
pub use core::models::authentication::{AuthenticationResponse, AuthenticationStatus};
pub use core::models::billing::{
    AllocationListResponse, AllocationResponse, AllocationStatus, AllocationTransferResponse,
    AutoRechargeConfig, BillingProfileResponse, BillingSetupResponse, BillingStatus, BlockReason,
    BlockedAttempt, BlockedAttemptListResponse, LedgerEntry, LedgerResponse, SuspensionSource,
    TierSummary, TopupResponse,
};
pub use core::models::common::{
    Address, AddressDetails, AuthenticationType, CaptureMethod, CustomerInfo, ListResponse,
    PhoneDetails, RefundType, SetupFutureUsage,
};
pub use core::models::connector::{
    ConnectorResponse, ConnectorWebhookEntry, ConnectorWebhookListResponse,
    ConnectorWebhookRegisterResponse,
};
pub use core::models::customer::CustomerResponse;
pub use core::models::dispute::DisputeResponse;
pub use core::models::ephemeral_key::EphemeralKeyResponse;
pub use core::models::event::{EventDeliveryAttemptResponse, EventResponse};
pub use core::models::fee::{
    FeeOwner, FeeRulePreviewResponse, FeeScheduleResponse, PlatformFeeRuleRecord,
};
pub use core::models::mandate::MandateResponse;
pub use core::models::merchant_account::MerchantAccountResponse;
pub use core::models::payment::{PaymentAttemptResponse, PaymentResponse};
pub use core::models::payment_link::PaymentLinkResponse;
pub use core::models::payment_method::PaymentMethodResponse;
pub use core::models::payout::PayoutResponse;
pub use core::models::poll::PollStatusResponse;
pub use core::models::profile::{PaymentIdFormatConfig, ProfileAcquirerResponse, ProfileResponse};
pub use core::models::project::{
    MerchantOverviewResponse, MerchantOverviewStat, ProjectResponse, ProjectStats,
    ProjectStatsResponse,
};
pub use core::models::refund::RefundResponse;
pub use core::models::region::{
    BuiltInRegionGroupResponse, RegionCountriesResponse, RegionResponse,
};
pub use core::models::routing::{
    ActiveRoutingAlgorithm, ActiveRoutingConfig, DefaultProfileRouting, MerchantRoutingAlgorithm,
    ProfileDefaultRoutingConfig, ProfileDeniedConnectorsResponse, RoutableConnectorChoice,
    RoutingDictionary, RoutingDictionaryRecord, SurchargeRuleResponse, TransactionType,
};
pub use core::models::shop::{
    CurrencyRevenue, GatewayResponse, PaymentIdStyle, ProfileLogoUploadResponse, ShopResponse,
    ShopStats, ShopStatsResponse,
};
pub use core::models::subscription::{
    CancelSubscriptionResponse, ConfirmSubscriptionResponse, PauseSubscriptionResponse,
    ResumeSubscriptionResponse, SubscriptionEstimateResponse, SubscriptionInvoice,
    SubscriptionItem, SubscriptionItemPrice, SubscriptionLineItem, SubscriptionPaymentData,
    SubscriptionResponse,
};
pub use core::models::user::{
    AddUserResponse, AuthResponse, InviteUsersResponse, LoginHistoryEntry, LoginHistoryResponse,
    MinimalRoleInfo, ParentGroup, ParentGroupInfo, PermissionScope, PhoneOtpResponse,
    PhoneOtpVerifyResponse, RecoveryCodesResponse, TokenPurpose, TokenResponse, TotpResponse,
    TotpSecret, UserInLineage, UserResponse, UserSessionEntry, UserSessionListResponse,
    UserSessionRevokeResponse,
};
pub use core::webhooks::{WebhookContent, WebhookEvent};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use http::client::{Delopay, DelopayBuilder, DelopayLogger, LogEvent};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::analytics::{Analytics, AnalyticsScopeParams};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::analytics_dashboard::AnalyticsDashboard;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::api_keys::{
    ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyListParams, ApiKeyResponse,
    ApiKeyRevokeResponse, ApiKeyUpdateRequest, ApiKeys,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::authentication::{Authentication, AuthenticationCreateRequest};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::availability_overrides::{
    AvailabilityOverrideCreateRequest, AvailabilityOverrides, AvailabilityPreviewParams,
    OverrideAction, OverrideScope,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::billing::{
    AllocationTransferRequest, AutoRechargeUpdateRequest, Billing, BillingAllocations,
    BillingCompleteSetupRequest, BillingSetupRequest, BlockedAttemptListParams, LedgerListParams,
    TopupRequest,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::blocklist::{
    Blocklist, BlocklistAddRequest, BlocklistDataKind, BlocklistEntryType, BlocklistListParams,
    BlocklistToggleParams,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::cards::Cards;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::connectors::{
    ConnectorCloneRequest, ConnectorCreateRequest, ConnectorUpdateRequest,
    ConnectorWebhookRegisterRequest, Connectors,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::customers::{CustomerCreateRequest, CustomerListParams, Customers};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::disputes::{DisputeEvidenceRequest, DisputeListParams, Disputes};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::ephemeral_keys::EphemeralKeys;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::events::Events;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::export::Export;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::feature_matrix::FeatureMatrix;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::fee_program::{
    ConditionNode, EuclidComparison, EuclidComparisonType, EuclidIfStatement, EuclidValue,
    FeeProgramBuilder, FeeProgramTree, FeeRuleConditions, FeeRuleInput, FeeRuleTree, FeeSpecInput,
    LeafNode, MetadataVariant, NumberComparison, PlatformFeeKind, PlatformFeeOutput,
    PlatformFeeProgram, PlatformFeeRule, PlatformFeeRuleOutput, all_of, any_of, encode_statements,
    fee_program, leaf, normalize_node, program_to_tree, rule_match_to_tree,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::fees::{
    FeeRules, FeeScheduleCreateRequest, FeeScheduleUpdateRequest, FeeType, Fees,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::files::Files;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::forex::Forex;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::mandates::{MandateListParams, Mandates};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::merchant_accounts::{
    MerchantAccountCreateRequest, MerchantAccountUpdateRequest, MerchantAccounts,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::payment_links::{PaymentLinkListParams, PaymentLinks};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::payment_methods::{
    CardUpdate, CustomerPaymentMethodsListParams, PaymentMethodCreateRequest,
    PaymentMethodListParams, PaymentMethodUpdateRequest, PaymentMethods,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::payments::{
    PaymentCancelRequest, PaymentCaptureRequest, PaymentConfirmRequest, PaymentCreateRequest,
    PaymentListParams, PaymentUpdateRequest, Payments,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::payouts::{PayoutCreateRequest, PayoutListParams, PayoutUpdateRequest, Payouts};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::poll::Poll;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::profile_acquirers::{
    ProfileAcquirerCreateRequest, ProfileAcquirerUpdateRequest, ProfileAcquirers,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::profiles::{ProfileCreateRequest, ProfileUpdateRequest, Profiles};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::projects::{ProjectCreateRequest, ProjectUpdateRequest, Projects, StatsPeriod};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::refunds::{RefundCreateRequest, RefundUpdateRequest, Refunds};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::regions::{
    RegionCreateRequest, RegionSetCountriesRequest, RegionUpdateRequest, Regions,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::relay::{
    Relay, RelayCaptureData, RelayData, RelayIncrementalAuthorizationData, RelayRefundData,
    RelayRequest, RelayType, RelayVoidData,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::routing::{
    MethodSurcharge, PerMethodSurchargeItem, Routing, RoutingActivatePayload,
    RoutingConfigCreateRequest, RoutingDeactivateRequest, RoutingDecision, SurchargeRuleRequest,
    SurchargeRules,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::search::{GlobalSearchRequest, Search, SearchTimeRange};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::shops::{
    GatewayConnectRequest, ShopCreateRequest, ShopGateways, ShopUpdateRequest, Shops,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::stripe_connect::{
    StripeConnect, StripeConnectAccountRequest, StripeConnectLinkRequest,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::subscriptions::{
    CancelSubscriptionRequest, ConfirmSubscriptionPaymentDetails, ConfirmSubscriptionRequest,
    CreateAndConfirmSubscriptionRequest, CreateSubscriptionPaymentDetails,
    CreateSubscriptionRequest, PauseSubscriptionRequest, ResumeSubscriptionRequest,
    SubscriptionEstimateParams, SubscriptionItemsParams, SubscriptionListParams,
    SubscriptionPaymentDetails, Subscriptions, UpdateSubscriptionRequest,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::three_ds_rules::{ThreeDsRuleExecuteRequest, ThreeDsRules};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::users::{
    AddUserRequest, ChangePasswordRequest, DeleteAccountRequest, DeleteUserRoleRequest,
    ForgotPasswordRequest, FromEmailRequest, ImpersonateEmployeeRequest, InviteUsersRequest,
    ListInvitableRolesParams, ListRolesParams, ListUsersInLineageParams, LoginHistoryParams,
    PhoneOtpRequest, PhoneOtpVerifyRequest, ResetPasswordRequest, SignInRequest, SignUpRequest,
    SignUpWithMerchantRequest, SwitchMerchantRequest, SwitchProfileRequest,
    Terminate2faQueryParams, UpdateUserDetailsRequest, UpdateUserRoleRequest, Users,
    VerifyTotpRequest,
};
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub use resources::verification::{ApplePayVerificationRequest, Verification};

/// Webhook signature verification and event parsing.
pub use core::webhooks;

/// Shared value types, re-exported for backwards compatibility.
pub mod types {
    pub use crate::core::models::common::*;
}

/// Production API base URL.
pub const PRODUCTION_URL: &str = "https://api.delopay.net";
/// Sandbox API base URL.
pub const SANDBOX_URL: &str = "https://sandbox.delopay.net";
/// Hosted-checkout base URL (the shopper-facing pay page).
pub const CHECKOUT_URL: &str = "https://checkout.delopay.net";