Add Customer Profile
This API is used to create a new customer profile in the Vault. It securely stores customer identity and contact details without including payment information. The generated customer profile ID can be reused for adding and managing multiple payment methods, ACH accounts, and transactions associated with the customer.
Typical Use Cases
- Creating a customer record before storing payment details
- Customer onboarding for recurring or saved-payment flows
API Reference: Add Customer Profile
Add Payment Profile
This API is used to add a card-based payment profile (credit or debit card) to an existing customer profile in the Vault. Card details are securely tokenized and stored, enabling future transactions without resubmitting sensitive card information.
Typical Use Cases
- Saving cards for faster checkout
- Subscription or recurring billing
- Card-on-file transactions.
API Reference: Add Payment Profile
Add ACH Profile
This API is used to add an ACH (bank account) payment profile to an existing customer profile. It securely stores routing and account information for future ACH transactions. The ACH profile can be used for one-time or recurring bank debit payments.
Typical Use Cases
- ACH-based subscriptions
- Bank debit payments
API Reference: Add ACH Profile
Add Payment Profile Using Token
This API allows adding a payment profile using an existing payment token instead of raw card details. It enables secure reuse of previously tokenized payment data while maintaining PCI compliance.
Typical Use Cases
- Migrating payment profiles
- Reusing tokens from hosted or external payment flows
- Secure card storage without exposing PAN data
API Reference: Add Payment Profile Using Token
Edit Customer Profile
This API is used to update customer profile information such as name, contact details, or address without affecting associated payment profiles.
Typical Use Cases
- Updating customer contact information
- Address changes
- Profile corrections
API Reference: Edit Customer Profile
Fetch Transaction with Date Range
This API retrieves transaction details for a specified date range. It allows filtering transactions based on time periods for reporting and reconciliation purposes.
Typical Use Cases
- Daily or monthly transaction reports
- Settlement and reconciliation
- Auditing and compliance
API Reference: Fetch Transaction with Date Range
Update Payment Profile
This API updates an existing card payment profile, such as expiration date or billing address, while keeping the stored card token intact.
Typical Use Cases
- Updating expired card details
- Billing address changes
- Maintaining card-on-file validity
API Reference: Update Payment Profile
Map Transaction with Date Range
This API maps and associates transactions to customer or payment profiles within a specified date range. It helps merchants correlate transaction history with stored customer and payment data.
Typical Use Cases
- Customer transaction history view
- Analytics and reporting
- Profile-based transaction tracking
API Reference: Map Transaction with Date Range
Update ACH Profile
This API updates an existing ACH payment profile, such as account type or billing details, without creating a new profile.
Typical Use Cases
- Bank account updates
- Correcting ACH profile details
- Maintaining recurring ACH payments
API Reference: Update ACH Profile
Edit Payment Profile
This API allows modification of card payment profile metadata such as card label, billing address, or profile status.
Typical Use Cases
- Managing saved cards
- Updating billing information
- Enabling or disabling payment profiles
API Reference: Edit Payment Profile
View Customer Profile
This API retrieves detailed information for a specific customer profile, including associated payment and ACH profiles.
Typical Use Cases
- Customer account view
- Support and troubleshooting
- Profile verification
API Reference: View Customer Profile
Get Payment Profile
This API retrieves details of a stored card payment profile associated with a customer, excluding sensitive card data.
Typical Use Cases
- Displaying saved cards
- Payment selection during checkout
- Profile validation
API Reference: Get Payment Profile
Get ACH Profile
This API retrieves details of a stored ACH payment profile associated with a customer.
Typical Use Cases
- Viewing saved bank accounts
- ACH payment selection
- Customer account management
API Reference: Get ACH Profile
Get Customer List
This API returns a list of customer profiles stored in the Vault, with optional pagination or filtering.
Typical Use Cases
- Merchant dashboards
- Customer management tools
- Reporting and exports
API Reference: Get Customer List
Delete ACH Profile
This API permanently removes an ACH payment profile from a customer account, preventing further transactions using that bank account.
Typical Use Cases
- Customer-requested deletion
- Compliance and data cleanup
- Payment method management
API Reference: Delete ACH Profile
Delete Customer Address
This API deletes a stored address associated with a customer profile without affecting payment profiles.
Typical Use Cases
- Address cleanup
- GDPR or data minimization compliance
API Reference: Delete Customer Address
Delete Customer Profile
This API deletes a customer profile from the Vault along with all associated payment and ACH profiles. Once deleted, the customer and related payment data cannot be recovered.
Typical Use Cases
- Account closure
- Compliance requirements
- Data lifecycle management
API Reference: Delete Customer Profile
Delete Payment Profile
This API removes a stored card payment profile from a customer account, disabling future card-based transactions using that profile.
Typical Use Cases
- Removing expired or unused cards
- Customer-requested card deletion
- Security and compliance