This guide explains how to use the save_payment_details parameter in the Payment Center API to control whether or not payment information is saved when processing payments.
Overview
The save_payment_details parameter provides flexibility in determining whether credit card or bank account information should be saved during API-based payment processing.
It supports the following options:
true – Payment details will be saved.
false – Payment details will NOT be saved.
Not passed – The system will fall back to the default setting in Payment Center Settings > Store Credit Card/Bank Account.
How It Works
1. When save_payment_details is Set to true
Behavior: Payment information is saved to the associated Payment Profile.
Use Case: Use this when you want to retain credit card or bank account details for future transactions or customer convenience.
2. When save_payment_details is Set to false
Behavior: Payment details are not stored.
Use Case: Best for one-time payments, or when compliance, privacy, or internal policies restrict saving payment information.
3. When the Parameter Is Not Passed
Behavior: The API defers to the configuration set in Payment Center Settings.
Configuration Reference: Navigate to Payment Center Settings > Store Credit Card/Bank Account to set the system-wide default behavior.
RELATED DOCUMENTATION
Availability: Spring '25