Skip to main content

Data Model - Payment Channel

smilepayz teamsAbout 2 min

Payment Channel Overview

The Payment Channel data model defines the structure for payment method and processing information. This model encapsulates payment method specifications, processing details, and channel-specific parameters.

Data Model Structure

ParameterTypeDescription
paymentMethodStringPayment method identifier
Format: Predefined payment method codes
Examples: BRI, UPI, QRPAY, PIX, SPEI
Used to identify the specific payment channel for transaction processing
vaNumberStringVirtual Account or Bank Account number
Format: Alphanumeric string
Usage: Indonesia VA numbers, Thailand bank accounts, Mexico SPEI accounts
Required for bank transfer payment methods
qrStringStringQR code data or image URL
Format: String or HTTP image URL
Usage: Indonesia QRIS, Thailand QRPAY, Brazil PIX
Contains QR code data for mobile payment processing
paymentUrlStringPrimary payment processing URL
Format: Valid HTTP/HTTPS URL
Usage: Smilepayz checkout page for payment completion
Required for all payment methods
payeeBankNameStringRecipient (payee) bank name for bank transfers
Format: UTF-8 encoded string
Usage: Thailand BANK method, Mexico SPEI
Specifies the receiving bank for transfer transactions
Preferred: integrations should read and store this field
receiverBankNameStringCompatibility only — same meaning as payeeBankName; populated from or mirrored to payeeBankName when either is returned. Prefer payeeBankName for new integrations; receiverBankName will be removed in a future version

Regional Implementation Examples

Indonesia Payment Methods

{
    "paymentMethod": "W_DANA",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200192501021315010115"
}

India Payment Methods

{
    "paymentMethod": "UPI",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200192501021315010115"
}

Thailand Payment Methods

{
    "paymentMethod": "QRPAY",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=111200572411191251468673",
    "qrString": "00020101021229370016A0000006770101110113006680870163353037645406299.985802TH63048436"
}

Brazil Payment Methods

{
    "paymentMethod": "PIX",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
    "qrString": "00020101021226800014br.gov.bcb.pix2558pix.delbank.com.br/v2/cob/vcharge1f6aed0623644c24bbdc174ce5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304BC39"
}

Mexico Payment Methods

{
    "paymentMethod": "SPEI",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1412075825061113364201615",
    "payeeBankName": "STP",
    "vaNumber": "6461805637046123212"
}

Peru Payment Methods

{
    "paymentMethod": "CASHIER_PE",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1512024025061111131298291"
}

Colombia Payment Methods

{
    "paymentMethod": "CASHIER_CO",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1512024025061111131298291"
}

Chile Payment Methods

{
    "paymentMethod": "CASHIER_CL",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1512024025061111131298291"
}

Implementation Guidelines

Payment Method Selection

  • Digital Wallets: Use e-wallet specific payment methods with additional payment URLs
  • QR Payments: Include QR string data for mobile payment processing
  • Bank Transfers: Provide virtual account numbers and payee bank information (prefer payeeBankName; receiverBankName remains for backward compatibility)
  • Cash Payments: Use cashier payment methods with external checkout URLs

Security Considerations

  • URL Validation: Ensure all payment URLs use HTTPS protocol
  • Data Encryption: Sensitive payment data should be encrypted in transit
  • Token Management: Secure handling of payment tokens and session data
  • Audit Logging: Maintain comprehensive logs for payment processing activities