For the complete documentation index, see llms.txt. This page is also available as Markdown.

Archipel

Accept card and wallet payments through Archipel.

Accept cards and Apple Pay through Archipel. Card transactions can use mandates, optional 3DS, refunds, and immediate or delayed capture. Apple Pay supports refunds and the same capture methods, but not mandates.

Status and capabilities

Integration status: live

Category: payment gateway

Webhook flows: None declared in code

Payment method
Type
Mandates
Refunds
Capture methods
3DS
Card networks
Countries
Currencies

card

Credit Card

supported

supported

automatic, manual, sequential automatic

supported, optional

American Express, Cartes Bancaires, Diners Club, Discover, Mastercard, Visa

-

-

card

Debit Card

supported

supported

automatic, manual, sequential automatic

supported, optional

American Express, Cartes Bancaires, Diners Club, Discover, Mastercard, Visa

-

-

wallet

Apple Pay

not supported

supported

automatic, manual, sequential automatic

not applicable

-

-

-

Authentication

Supply a CA Certificate PEM in the connector API Key field. Hyperswitch maps that field to ca_certificate and attaches the PEM certificate to connector requests instead of sending an authorization header. See ArchipelAuthType::try_from(), get_auth_header(), and the certificate attachment in build_request().

The connector also requires two metadata fields. Requests fail with an invalid connector configuration error if either is missing. See ArchipelConfigData.

Field
Metadata key
Format

Tenant ID

tenant_id

Your Archipel tenant ID

Platform Endpoint Prefix

platform_url

Host and port only, for example 192.0.0.1:8080. Do not include https:// or a path

Hyperswitch builds the request URL as https://<Platform Endpoint Prefix>/ArchiPEL/Transaction/v1, so a value that already includes https:// produces an invalid URL. See build_env_specific_endpoint() and the production base URL.

Before you start

  1. Have the CA Certificate PEM, Tenant ID, and Platform Endpoint Prefix ready.

  2. To accept Apple Pay, set up Apple Pay with Hyperswitch decryption first. Archipel accepts only Apple Pay tokens that Hyperswitch has decrypted, and the connector requires these Apple Pay fields: merchant certificate, merchant private key, Apple merchant identifier, display name, domain (web or ios), domain name, merchant business country, and payment processing location (Hyperswitch). See the Apple Pay token handling and the connector metadata fields.

To connect Archipel to your Hyperswitch account, follow Activate a connector on Hyperswitch, then return here for what Archipel supports.

Webhooks

Archipel webhooks are not supported. Use payment sync for payment status updates. The connector's webhook handlers all return WebhooksNotImplemented; see IncomingWebhook for Archipel.

Source reference

Authentication, setup, and webhook behavior on this page is tied to Hyperswitch d8b6ebe773690aa37cf249b2992c2358dbd7f438. See Archipel connector source and Archipel transformers.

Last updated

Was this helpful?