MerchantBillingPaymentMethodDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read-side projection of a `MerchantBillingPaymentMethod` for display in the operator UI. Carries only the display metadata; the token reference is opaque to the operator and the PAN / full account number is never represented at this layer or any layer above it.
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 | ||||
|---|---|---|---|---|---|---|
id
required |
string (uuid) | Stable id for the payment-method row.
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.
| ||||
resellerId
required |
string (uuid) | The reseller that owns the (billed-merchant → token) pairing.
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.
| ||||
merchantId
required |
string (uuid) | The merchant being billed.
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 collection merchant under whose vault the token lives.
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.
| ||||
kind
required |
MerchantBillingPaymentMethodKind MerchantBillingPaymentMethodKind | Funding instrument family.
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.
| ||||
brand
required |
string | Card brand display string (e.g., "Visa"). Null when `kind` is ACH.
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.
| ||||
last4
required |
string | Last 4 digits of PAN / ACH account number, for display only.
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.
| ||||
expMonth
required |
integer (int32) | Card expiration month (1-12). Null when `kind` is ACH.
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.
| ||||
expYear
required |
integer (int32) | Card expiration year (4-digit). Null when `kind` is ACH.
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.
| ||||
achAccountType
required |
MerchantBillingAchAccountType MerchantBillingAchAccountType | ACH account type. Null when `kind` is Card.
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.
| ||||
isActive
required |
boolean | True while this is the active payment method for the (reseller, merchant) pair.
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.
| ||||
deactivatedAt
required |
string (date-time) | When the row was deactivated. Null while `isActive` 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.
| ||||
creationTime
required |
string (date-time) | Creation timestamp from `FullAuditedAggregateRoot`.
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 | Concurrency stamp for optimistic concurrency.
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.