A Payment Method Configuration defines the specific settings and parameters for a payment method within a payment configuration. It includes settings such as interest rates, installment limits, take rates, and transfer timing.
Payment Method Configuration Schema
Field
Description
Type
id
Unique identifier (UUID)
String
take_rate_type
How the take rate is calculated. Can be absolute (fixed amount) or percentage (percentage of amount)
String
take_rate_value
The take rate value - either a fixed amount in cents or a percentage as decimal (e.g., 0.025 for 2.5%)
Float
max_installments
Maximum number of installments allowed for this payment method
Integer
min_installment_amount_cents
Minimum amount in cents required for each installment
Integer
configuration_type
Type of configuration: installment (for recurring payments) or down_payment (for initial payment)
String
payment_method
Payment method type: boleto, pix, or credit_card
String
days_to_transfer
Number of days until the payment is transferred to the receiver after capture
Integer
interest_rate
Interest rate applied to installment payments (as decimal, e.g., 0.0199 for 1.99% monthly)
Float
smart_payment_enabled
Whether smart payment (automatic payment method selection) is enabled for this configuration
Boolean
Configuration Type Values
Value
Description
installment
Configuration for recurring installment payments after the down payment
down_payment
Configuration for the initial down payment (first payment) of a financed purchase
Payment Method Values
Value
Description
boleto
Brazilian bank slip payment method (boleto bancário)
pix
Brazilian instant payment system
credit_card
Credit card payment method, which supports multiple installments
Take Rate Type Values
Value
Description
absolute
The take_rate_value represents a fixed amount in cents deducted from each transaction
percentage
The take_rate_value represents a percentage (as decimal) of the transaction amount to be deducted
Validation Rules
Interest rate must be greater than or equal to 0
Minimum installment amount must be greater than or equal to 0
Max installments must be exactly 1 for boleto and pix payment methods (only credit_card supports multiple installments)
Payment method must be unique per configuration_type within a payment configuration
Days to transfer must be a non-negative integer
Smart payment enabled must be explicitly true or false