Documentation Index
Fetch the complete documentation index at: https://docs.ecrypt.com/llms.txt
Use this file to discover all available pages before exploring further.
What Is a Customer?
A customer record in ECRYPT stores profile information and saved payment methods. Once created, a customer can be charged directly through the API without re-collecting card or bank account details.
ECRYPT automatically generates a unique ID when a customer record is saved.
Customer Profile
Customer profiles are organized into four field groups:
| Field | Description |
|---|
| Customer name | Full name |
| Mailing address | Mailing address |
| Email address | Email address |
| Phone number | Phone number |
| Customer ID | Auto-generated unique identifier |
Credit Card Details
| Field | Description |
|---|
| Cardholder name | Name on card |
| Credit card number | Card number |
| Expiration date | Card expiration date |
| Billing address | Billing street address |
| Billing zip code | Billing zip code |
ACH Details
| Field | Description |
|---|
| Accountholder | Name on bank account |
| Account number | Bank account number |
| Routing number | Bank routing number |
| Billing address | Billing street address |
| Billing zip code | Billing zip code |
| Field | Description |
|---|
| Shipping address | Shipping street address |
| City | City |
| State | State |
| Zip code | Zip code |
| Country | Country |
| Phone number | Shipping phone number |
Merchant-Defined Fields
Merchant-defined fields are custom fields that can be added to customer records and displayed in checkout experiences. You can create up to 21 merchant-defined fields and choose from the following field types:
| Field Type | Description |
|---|
| Text Box | Simple text input for data like reference IDs, names, phone numbers, and similar values |
| Dropdown | A selection list allowing the customer or merchant to choose one option from multiple choices |
| Radio Select | A checkbox-style input for yes/no questions or multi-option selection |
Customer Wallet
Each customer profile includes a wallet that can hold up to 4 payment methods. Both credit card and ACH payment methods are supported.
All card numbers and bank account numbers are tokenized and displayed as truncated values. ECRYPT does not store raw payment data after the initial tokenization, removing your responsibility for storing sensitive payment information.
Common Use Cases
Charge a Customer on File
Once a customer has a saved payment method, you can charge them by referencing their customer ID and wallet token — no need to re-collect payment details. Useful for repeat purchases, invoicing, and agent-assisted payments.
Subscriptions
Subscriptions are linked to a customer record and automatically charge a designated wallet payment method on a defined schedule. See Subscriptions.
Installment Plans
Installment plans split a total amount into scheduled charges against a customer’s wallet. Like subscriptions, they are tied to a customer record and run automatically. See Installment Plans.
Stored Card at Checkout
During an online checkout flow, returning customers can select a saved card from their wallet rather than re-entering payment details. This is supported through the Hosted iFrame and Checkout Page by passing a customer reference at load time.
