ContractPayMethod
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents a payment method attached to a recurring billing contract. Exactly one of two shapes is expected on a Create request: <list type="bullet"> <item><description><b>Tokenised:</b> set `paymentTokenReference` (the opaque `pt_` handle) to reference a previously stored payment method, for either `type` = `Card` or `type` = `Check`. `card` and `check` must be left null; the recurring billing engine resolves the underlying card or bank-account data from the token store at execution time. This is the recommended shape because it keeps PCI scope at the token layer.</description></item> <item><description><b>Raw:</b> populate `card` (when `type` is `Card`) or `check` (when `type` is `Check`) with the account data. Both token fields must be null.</description></item> </list> The Create validator rejects payloads that mix both shapes (a token alongside raw `card`/`check` data) or that omit both.
Values
Fields
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
required |
ContractPayMethodType ContractPayMethodType | Gets or sets the funding instrument family. Determines which raw-data field (`card` or `check`) is consulted when the payment method carries no token binding (neither `paymentTokenReference` nor `paymentTokenId`).
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.
| ||||||||||||||||||||||||
paymentTokenId
required |
string (uuid) | Internal vault identifier of a previously stored payment method, valid for both `Card` and `Check` contracts. This value correlates directly to stored cardholder data and is an <b>internal</b> binding: prefer `paymentTokenReference` on every external integration. It remains accepted inbound for callers that have not yet migrated, and is resolved and re-stamped server-side on every contract write.
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.
| ||||||||||||||||||||||||
card
required |
StoredCard StoredCard | Raw card account data. Populate only when no token is supplied and `type` is `Card`. Prefer `paymentTokenReference` for new integrations.
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 StoredCard:
This body has no documented fields. | ||||||||||||||||||||||||||
check
required |
StoredCheck StoredCheck | Raw check / ACH account data. Populate only when no token is supplied and `type` is `Check`. Prefer `paymentTokenReference` (a stored check/ACH token) for new integrations.
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 StoredCheck:
This body has no documented fields. | ||||||||||||||||||||||||||
paymentTokenReference
required |
string | The externally-emitted, chargeable public reference of the stored payment method this contract bills: the opaque `pt_`-prefixed handle returned when the payment method was stored. This is the identifier external integrations should use, and it is valid for both `Card` and `Check` contracts.
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.