extraProperties
required |
object
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
createdFromTemplateId
required |
string (uuid)
|
The template this record was created from, or `null` for one started blank. Set by the
create-from-template path and by the add/edit page's Load Template action when the record is
saved.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
concurrencyStamp
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
tenantId
required |
string (uuid)
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
entityVersion
required |
integer (int32)
|
read only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
parentReseller
required |
string (uuid)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
customIdentifier
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
dba
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
code
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
features
required |
ResellerFeatures
ResellerFeatures |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerFeatures:
| Field |
Type |
Description |
|---|
privateLabeling
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| hostedPage
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| emulator
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| merchantCustomFieldConfig
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| merchantBilling
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| tokenSharing
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| subResellers
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| tenders
required |
TenderEnableFlags
TenderEnableFlags |
Per-tender enable flags evaluated by the capability cascade. A
reseller that has not explicitly opted in to a non-credit tender (EBT/eWIC)
blocks every merchant beneath it from accepting that tender, regardless of
merchant-level or processor-account opt-in.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| paymentTokenization
required |
boolean
|
Reseller-level opt-in for payment tokenization. When `false` or unset, every merchant
beneath this reseller is blocked from tokenizing payments regardless of the per-merchant
`enablePaymentTokenization` override.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
contactDetail
required |
ResellerContactDetail
ResellerContactDetail |
Represents contact details for a reseller.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerContactDetail:
| Field |
Type |
Description |
|---|
primaryContactName
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| emailAddress
required |
string
|
The contact's email address. Optional. A value that is not blank must be a valid email address.
Conditional: When EmailAddress is not empty. Must be a valid email.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| phone
required |
string
|
The contact's phone number. Optional. A value that is not empty must be a phone number: digits,
with an optional leading `+` and country code, optional parentheses around the area code,
and a space, hyphen or period between groups. Letters, including an extension such as
`x123`, are rejected.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| fax
required |
string
|
The contact's fax number. Optional. Follows the same rule as the phone number.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| companyUrl
required |
string
|
The company's website address. Optional. A value sent without a scheme, such as
`www.example.com`, is stored with `https://` added. A value that starts with
`http://` or `https://` is stored exactly as sent. Any other scheme, and text that is
not a website address, is rejected.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| addresses
required |
array of AddressInputModel
array of AddressInputModel |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
businessInfo
required |
ResellerBusinessInfo
ResellerBusinessInfo |
Represents business-related information for a reseller.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerBusinessInfo:
| Field |
Type |
Description |
|---|
federalTaxId
required |
string
|
nullablemax length 50
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| stateTaxId
required |
string
|
nullablemax length 50
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| salesTaxId
required |
string
|
nullablemax length 50
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| yearlySalesAmount
required |
number (double)
|
Conditional: When YearlySalesAmount is not null. Must be > 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| businessStartDate
required |
string (date-time)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| currency
required |
string
|
nullablemax length 3
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
branding
required |
ResellerBranding
ResellerBranding |
Represents branding information for a reseller, including domain, product, contact, and icon details.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerBranding:
| Field |
Type |
Description |
|---|
brandedDomainName
required |
string
|
Gets or sets the branded domain name for the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| productName
required |
string
|
Gets or sets the product name for the reseller's offering.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| emailFromName
required |
string
|
Gets or sets the display name used in emails sent from the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| emailFromAddress
required |
string
|
Gets or sets the email address used as the sender in emails from the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| logo
required |
string
|
Gets or sets the URL or path to the reseller's logo.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| displayAddress
required |
Address
Address |
Gets or sets the display address for the reseller.
Conditional: Conditional (see validator source).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| sdkGlobalName
required |
string
|
Gets or sets the window-global name the branded embed SDK shim assigns to the
brand-neutral core artifact (for example "MyBrandPaySDK"). Falls back to the platform
default global name when unset.
Conditional: When SdkGlobalName is not empty. Max length: 60.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| supportPhone
required |
string
|
Gets or sets the support phone number for the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| salesPhone
required |
string
|
Gets or sets the sales phone number for the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| supportEmail
required |
string
|
Gets or sets the support email address for the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| favIcons
required |
BrandingFavIcons
BrandingFavIcons |
Gets or sets the favicon and icon URLs for the reseller's branding.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
billingPreferences
required |
ResellerBillingPreferences
ResellerBillingPreferences |
Per-reseller billing configuration embedded on the Reseller aggregate root.
Controls billing run scheduling, payment terms, and invoice generation preferences.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerBillingPreferences:
| Field |
Type |
Description |
|---|
defaultPaymentTerms
required |
integer (int32)
|
Days until invoice due date (e.g. 30).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| defaultCurrency
required |
string
|
ISO 4217 default currency for billing.
nullablemin length 0max length 3
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| hppPageId
required |
string (uuid)
|
HPP page ID used for invoice payment links.
Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| captureHppPageId
required |
string (uuid)
|
HPP page ID used to capture and store a card on file for the recurring-contract billing
path (the operator-driven payment-method capture flow). This must reference a
`SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not
prompt the operator for an amount. Distinct from `hppPageId`, which is the
Invoicing payment-link page (a chargeable `Payment` page).
Required: When DefaultFulfillmentPath == RecurringContract.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| allowOnlinePayment
required |
boolean
|
Whether merchants can pay invoices online via HPP.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| allowStoredPaymentMethods
required |
boolean
|
Whether merchants can store payment methods for billing.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| autoChargeStoredMethod
required |
boolean
|
Auto-charge stored payment method after invoice generation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| autoBillingEnabled
required |
boolean
|
Whether automated billing runs are enabled.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| billingPeriod
required |
integer (int32)
|
Billing period: 1=Monthly, 3=Quarterly.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| billingDayOfMonth
required |
integer (int32)
|
Day of month for billing runs (1-28).
nullablemin 1max 28
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| invoiceTemplateId
required |
string (uuid)
|
Invoice template ID (Phase 2: Invoicing module).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| defaultTaxRateId
required |
string (uuid)
|
Default tax rate ID (Phase 2: Invoicing module).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| sendInvoiceOnGeneration
required |
boolean
|
Auto-send invoice to merchant after generation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| billingRunNotificationEmail
required |
string
|
Admin notification email for billing run completions.
nullablemin length 0max length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| defaultFulfillmentPath
required |
BillingFulfillmentPath
BillingFulfillmentPath |
Default fulfillment path for billing runs under this reseller. When null and a merchant
has no per-assignment override, the merchant is skipped with result status
`NoFulfillmentPath`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Invoicing |
Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page. | RecurringContract |
Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant. |
| collectionMerchantId
required |
string (uuid)
|
The reseller-owned billing entity that owns recurring contracts and vaults stored
payment methods. Required when `defaultFulfillmentPath` is
`RecurringContract`. This may be the reseller itself
or a designated child merchant; modeled internally as a single "MLB collection party"
reference so the legacy House Merchant flag is not reintroduced.
Required: When DefaultFulfillmentPath == RecurringContract.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| allowCardPayments
required |
boolean
|
Whether card tokens are permitted as stored payment methods for billed merchants.
Treated as `true` by callers when null on legacy documents.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| allowAchPayments
required |
boolean
|
Whether ACH tokens are permitted as stored payment methods for billed merchants.
Treated as `true` by callers when null on legacy documents, matching
`allowCardPayments`: both are read permissively, rejecting only an explicit
`false`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
processingDefaults
required |
ResellerProcessingDefaults
ResellerProcessingDefaults |
Gets or sets the portfolio-wide processing defaults applied to merchants under this reseller
that have left the matching merchant-level setting unset. `null` when the reseller sets
no defaults.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ResellerProcessingDefaults:
| Field |
Type |
Description |
|---|
enableCreateIdempotency
required |
boolean
|
Default for `Merchant.Processing.EnableCreateIdempotency`, applied to every merchant under
this reseller that has left its own value unset. `null` means the reseller sets
no default and an unset merchant runs with create idempotency off, as before.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| cardAcceptancePolicy
required |
CardAcceptancePolicy
CardAcceptancePolicy |
Default for `Merchant.Processing.CardAcceptancePolicy`, applied to every merchant under
this reseller that has no policy of its own. `null` means the reseller sets no
default and a merchant without a policy accepts every card, as before.
Conditional: When CardAcceptancePolicy is not null.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
isTest
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
legacyNumber
required |
integer (int64)
|
Gets the reseller's legacy numeric key, the integer identifier the v1 API addresses resellers
by (its `ResellerKey`). Server-owned and stamped once at create; null on resellers written
before the field existed until the v1 data migration back-fills them.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
notes
required |
array of EntityNote
array of EntityNote |
Gets or sets operational notes attached to the reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each EntityNote:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| enteredBy
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| timestamp
required |
string (date-time)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| enteredByName
required |
string
|
Denormalized display name of the user who created the note.
Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| content
required |
string
|
nullablemin length 0max length 1000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |