Skip to main content

Overview

Payers are entities responsible for invoice payments. The Payers API enables managing:
  • Payer information
  • Customer associations
  • Contact details
  • Payment preferences

Core Concepts

Payer Properties

Metadata Options

Validation Rules

Country Code

  • Must be ISO 3166-1 alpha-3
  • Pattern: ^[A-Z]{3}$
  • Must be active country

Contact Rules

  • Valid email format
  • Valid customer reference
  • Unique email per customer

Security Requirements

  • Customer-scoped access
  • Role-based permissions
  • Audit logging
  • Data validation
See individual endpoint documentation for detailed request/response formats and examples.