EffectiveCollectionConfigurationDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The collection configuration that governs a reseller's merchant billing once inheritance has been applied, and which reseller it comes from.
Values
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
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
resellerId
required |
string (uuid) | The reseller the configuration was resolved for.
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.
| ||||
sourceResellerId
required |
string (uuid) | The reseller whose configuration applies. Equal to `resellerId` when the reseller
is governed by its own configuration, or when nothing is configured on it or any ancestor.
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.
| ||||
sourceResellerName
required |
string | The display name of `sourceResellerId`, when it resolved.
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.
| ||||
isInherited
required |
boolean | Whether the configuration comes from an ancestor rather than the reseller itself.
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.
| ||||
isConfigured
required |
boolean | Whether a collection merchant is configured on the effective set.
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 | The effective default fulfillment path.
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.
| ||||
collectionMerchantId
required |
string (uuid) | The effective collection merchant.
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) | The effective card-capture Hosted Payment Page.
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 | The effective card allow flag. An unset flag permits card capture.
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 | The effective ACH allow flag. An unset flag permits ACH capture.
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 model has no documented fields.