Data Model - Payer

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

Parameter	Type	Description
name	String	Customer'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"
email	String	Customer's email address for notifications Format: Valid email address Usage: Transaction notifications, payment confirmations, and communication Examples: "[email protected]", "[email protected]"
phone	String	Customer's phone number for contact purposes Format: International phone number format Usage: Transaction verification, support communication, and SMS notifications Examples: "62895359978010", "51987654321"
address	String	Customer's physical address Format: UTF-8 encoded string Usage: Optional for most transactions, used for compliance and verification Examples: "123 Main Street, City, Country"
idType	String	Identity document type specification Format: NID, FID, PP, TIN — National ID, Foreigner ID, Passport, Tax Identification Number Usage: Varies by region, used for identity verification and compliance Examples: NID, FID, PP, TIN
idNumber	String	Identity document number Format: Alphanumeric string Usage: Must match the specified idType format, used for customer verification Examples: "0123456789", "48982488880"
accountNo	String	Bank account number for transfers Format: Alphanumeric string Usage: Required for Thailand bank transfers, used for account identification Examples: "0123456789", "2345678912"
bankName	String	Bank name for account identification Format: UTF-8 encoded string Usage: Recommended for Thailand transactions, used for bank verification Examples: "KBANK", "BRI", "BCP"
pixType	String	Brazil PIX identifier type: CPF (individual) or CNPJ (business). Must match the format of pixAccount. Examples: CPF, CNPJ
pixAccount	String	Brazil PIX identifier value (the number only) Format: 11 digits when pixType is CPF, 14 digits when CNPJ; digits only Usage: Required with pixType for Brazil PIX pay-in Examples: "48982488880" (CPF), "12345678000199" (CNPJ)

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: pixType, pixAccount (pixType = CPF | CNPJ; pixAccount = corresponding numeric ID)
• 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"
}

{
  "name": "Somchai Srisai",
  "accountNo": "0123456789",
  "bankName": "KBANK"
}

{
  "pixType": "CPF",
  "pixAccount": "0123456789"
}

{
  "name": "Carlos Rodriguez Mendoza"
}

{
  "name": "Juan Carlos Rodriguez"
}

{
  "name": "Maria Santos Cruz",
  "email": "[email protected]",
  "phone": "63987654321"
}

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