Skip to main content

Data Model - Payer

smilepayz teamsAbout 2 min

Payer Overview

The Payer data model defines the structure for customer information in pay-in transactions. This model encapsulates customer identification, contact information, and regional compliance requirements.

Data Model Structure

ParameterTypeDescription
nameStringCustomer's full name for transaction identification
Format: UTF-8 encoded string
Usage: Required for most regions, used for transaction records and customer verification
Examples: "John Doe", "Carlos Rodriguez Mendoza"
emailStringCustomer's email address for notifications
Format: Valid email address
Usage: Transaction notifications, payment confirmations, and communication
Examples: "[email protected]", "[email protected]"
phoneStringCustomer's phone number for contact purposes
Format: International phone number format
Usage: Transaction verification, support communication, and SMS notifications
Examples: "62895359978010", "51987654321"
addressStringCustomer's physical address
Format: UTF-8 encoded string
Usage: Optional for most transactions, used for compliance and verification
Examples: "123 Main Street, City, Country"
idTypeStringIdentity document type specification
Format: Predefined identity type codes
Usage: Varies by region, used for identity verification and compliance
Examples: DNI, CE, PAS, RUC
identityStringIdentity document number
Format: Alphanumeric string
Usage: Must match the specified idType format, used for customer verification
Examples: "0123456789", "48982488880"
accountNoStringBank account number for transfers
Format: Alphanumeric string
Usage: Required for Thailand bank transfers, used for account identification
Examples: "0123456789", "2345678912"
bankNameStringBank name for account identification
Format: UTF-8 encoded string
Usage: Recommended for Thailand transactions, used for bank verification
Examples: "KBANK", "BRI", "BCP"
pixAccountStringPIX account identifier for Brazil
Format: Alphanumeric string
Usage: Required for Brazil PIX transactions, used for payment processing
Examples: "0123456789", "12345678988"

Regional Requirements

Indonesia Pay-In Requirements

  • OVO Payment: phone is required
  • Other Methods: Varies by payment method
  • Purpose: Mobile payment verification and notifications

Thailand Pay-In Requirements

  • Required Fields: name, accountNo
  • Recommended Fields: bankName
  • Purpose: Bank transfer identification and verification

Brazil Pay-In Requirements

  • Required Fields: pixAccount
  • Optional Fields: All other fields
  • Purpose: PIX payment processing and identification

Peru Pay-In Requirements

  • Required Fields: name
  • Optional Fields: All other fields
  • Purpose: Basic customer identification

Colombia Pay-In Requirements

  • Required Fields: name
  • Optional Fields: All other fields
  • Purpose: Basic customer identification

Philippines Pay-In Requirements

  • Required Fields: name, email, phone
  • Optional Fields: All other fields
  • Purpose: Customer identification and communication

Implementation Examples

{
  "phone": "62895359978010"
}

Data Validation and Security

Identity Verification

  • Document Validation: All identity documents must be valid and current
  • Format Verification: Identity numbers must match regional format requirements
  • Cross-Reference: Identity information is verified against official databases where applicable

Contact Information

  • Email Validation: Email addresses must be in valid format and deliverable
  • Phone Validation: Phone numbers must be in international format and valid
  • Communication Preferences: Respect customer communication preferences

Data Privacy

  • Encryption: All personal data is encrypted in transit and at rest
  • Access Control: Strict access controls for sensitive customer information
  • Audit Trail: Complete audit trail for all data access and modifications

Regional Compliance

  • Local Regulations: Adherence to regional data protection and privacy laws
  • Payment Regulations: Compliance with local payment processing regulations
  • AML/KYC: Anti-money laundering and know-your-customer compliance
Last update: