Skip to content

Latest commit

 

History

History
62 lines (56 loc) · 2.94 KB

PayorV2.md

File metadata and controls

62 lines (56 loc) · 2.94 KB
Raw

VeloPayments::PayorV2

Properties

Name Type Description Notes
payor_id String [readonly]
payor_name String The name of the payor.
payor_xid String A unique identifier that an external system uses to reference the payor in their system [optional]
address PayorAddressV2 [optional]
primary_contact_name String Name of primary contact for the payor. [optional]
primary_contact_phone String Primary contact phone number for the payor. [optional]
primary_contact_email String Primary contact email for the payor. [optional]
kyc_state KycState [optional]
manual_lockout Boolean Whether or not the payor has been manually locked by the backoffice. [optional]
payee_grace_period_processing_enabled Boolean Whether grace period processing is enabled. [optional][readonly]
payee_grace_period_days Integer The grace period for paying payees in days. [optional][readonly]
collective_alias String How the payor has chosen to refer to payees. [optional]
support_contact String The payor’s support contact email address. [optional]
dba_name String The payor’s 'Doing Business As' name. [optional]
allows_language_choice Boolean Whether or not the payor allows language choice in the UI. [optional]
reminder_emails_opt_out Boolean Whether or not the payor has opted-out of reminder emails being sent. [optional][readonly]
language String The payor’s language preference. Must be one of [EN, FR]. [optional]
includes_reports Boolean [optional]
wu_customer_id String [optional]
max_master_payor_admins Integer [optional]
payment_rails PaymentRails [optional]
transmission_types TransmissionTypes2 [optional]
remote_system_ids Array<String> The payor’s supported remote systems by id [optional]

Example

require 'velopayments'

instance = VeloPayments::PayorV2.new(
  payor_id: null,
  payor_name: Example, Corp,
  payor_xid: ABC_201234,
  address: null,
  primary_contact_name: Joe Buck,
  primary_contact_phone: 123-123-1234,
  primary_contact_email: joe.buck@example.com,
  kyc_state: null,
  manual_lockout: null,
  payee_grace_period_processing_enabled: null,
  payee_grace_period_days: null,
  collective_alias: Payee,
  support_contact: support@example.com,
  dba_name: Some Biz,
  allows_language_choice: null,
  reminder_emails_opt_out: null,
  language: EN,
  includes_reports: null,
  wu_customer_id: null,
  max_master_payor_admins: null,
  payment_rails: null,
  transmission_types: null,
  remote_system_ids: null
)