Package-level declarations

Types

Link copied to clipboard
data class Agreements(val merchantAccount: List<MerchantAccount>? = null, val timeFrame: TimeFrame? = null)

Represents agreements and terms for a payment method. This class contains information about merchant accounts and time frames associated with the payment method's agreements.

Link copied to clipboard
data class BuyerIdentification(val name: String, val number: String? = null, val type: String? = null)

Represents the buyer's identification information for payment processing. This class contains the necessary identification details of the cardholder, including name and optional identification number and type. For testing purposes, specific status codes can be included in the name to simulate different payment scenarios.

Link copied to clipboard
data class CardIssuer(val id: String? = null, val merchantAccountId: String? = null, val processingMode: String? = null, val status: String? = null, val thumbnail: String? = null)

Represents a card issuer entity in the payment processing system. This class contains information about the financial institution that issued the payment card, including its identification, processing details, and visual representation.

Link copied to clipboard
data class CardModel(val bin: Int? = null, val length: LengthModel? = null, val validation: String? = null, val securityCode: SecurityCodeModel? = null)

Represents detailed card information and validation rules. This class contains all card-specific details including BIN, length requirements, and security code specifications. It is used to validate card information before processing.

Link copied to clipboard
data class CardToken(val token: String)

Represents a tokenized card for secure payment processing. This class contains the token generated after successful card tokenization, which is used to process payments without handling sensitive card data directly.

Link copied to clipboard
data class FinancialInstitutionModel(val id: String?, val description: String)

Represents a financial institution that processes payments. This class contains information about banks or financial entities that are authorized to process transactions for a payment method.

Link copied to clipboard
data class IdentificationType(val id: String? = null, val name: String? = null, val type: String? = null, val minLength: Int? = null, val maxLength: Int? = null)

Represents a type of identification document used for payment processing. This class contains information about different identification document types supported by the payment system, including their validation rules and display names. Common examples include national ID cards, passports, and tax identification numbers.

Link copied to clipboard
data class Installment(val paymentMethodId: String? = null, val paymentTypeId: String? = null, val issuer: Issuer? = null, val processingMode: String? = null, val merchantAccountId: String? = null, val payerCost: List<PayerCost>? = null, val agreements: List<Agreements>? = null)

Represents installment options and payment details for a specific payment method. This class contains comprehensive information about available installment plans, including costs, rates, and processing details for a payment method. It helps merchants and users understand the total cost and payment options.

Link copied to clipboard
data class Issuer(val id: String? = null, val thumbnail: String? = null, val default: Boolean? = null)

Represents information about the card issuer or financial institution. This class contains details about the entity that issues the payment method, including its identification and visual representation.

Link copied to clipboard
data class LengthModel(val min: Int? = null, val max: Int? = null)

Defines the length requirements for a card number. This class specifies the valid length range for card numbers to ensure proper validation of card information.

Link copied to clipboard
data class MerchantAccount(val id: String? = null, val paymentMethodOptionId: String? = null)

Represents a merchant account associated with a payment method. This class contains identification information for a merchant's payment processing account.

Link copied to clipboard
data class PayerCost(val instalments: Int? = null, val installmentAmount: Float? = null, val instalmentsRate: Float? = null, val installmentRateCollector: List<String>? = null, val totalAmount: Float? = null, val minAllowedAmount: Float? = null, val maxAllowedAmount: Float? = null, val discountRate: Float? = null, val reimbursementRate: Float? = null, val labels: List<String>? = null, val paymentMethodOptionId: String? = null)

Represents detailed cost information for an installment plan. This class contains all financial details related to an installment option, including rates, amounts, and payment terms.

Link copied to clipboard
data class PaymentMethod(val financialInstitution: List<FinancialInstitutionModel>? = null, val payerCost: List<PayerCost>? = null, val issuer: Issuer? = null, val totalFinancialCost: String? = null, val minAccreditationDays: String? = null, val maxAccreditationDays: String? = null, val merchantAccountId: String? = null, val id: String? = null, val paymentTypeId: String? = null, val accreditationTime: String? = null, val card: CardModel? = null, val thumbnail: String? = null, val bins: List<Int>? = null, val marketplace: String? = null, val deferredCapture: String? = null, val agreements: List<Agreements>? = null, val labels: List<String>? = null, val siteId: String? = null, val processingMode: String? = null, val additionalInfoNeeded: List<String>? = null, val status: String? = null)

Represents a payment method with comprehensive details for financial transactions. This class encapsulates all necessary information about a payment method including its processing rules, validation requirements, and associated costs. It supports various payment types like credit cards, debit cards, and other payment methods.

Link copied to clipboard

Defines the processing modes available for payment methods. This enum represents different ways in which payments can be processed, affecting how transactions are handled and settled.

Link copied to clipboard
sealed class ResultError

Represents different types of errors that can occur during SDK operations. This sealed class provides a type-safe way to handle various error scenarios, including request failures and validation errors. It helps standardize error handling across the SDK.

Link copied to clipboard
data class SecurityCodeModel(val mode: String? = null, val location: String? = null, val length: Int? = null)

Defines the security code (CVV) requirements for a card. This class specifies how the security code should be handled, including its location on the card and length requirements.

Link copied to clipboard
data class TimeFrame(val startDate: String? = null, val endDate: String? = null)

Represents a time period for an agreement or promotion. This class defines the validity period for payment method agreements, promotions, or special conditions.