CardAcceptancePolicyDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The cards a merchant is willing to take, judged from the card's BIN. Additive and optional on the merchant create, update and read surfaces: a caller that omits it gets today's behaviour, which is that every card is accepted.
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
acceptCredit
required |
boolean | Whether credit cards are accepted. Omitted or null accepts 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.
| ||||||||
acceptDebit
required |
boolean | Whether debit cards are accepted. Omitted or null accepts 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.
| ||||||||
acceptPrepaid
required |
boolean | Whether prepaid cards are accepted. Omitted or null accepts them. Prepaid is an overlay on
the debit or credit rail, so a prepaid debit card is refused if either this or
`acceptDebit` is off.
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.
| ||||||||
acceptConsumer
required |
boolean | Whether consumer (personally issued) cards are accepted. Omitted or null accepts 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.
| ||||||||
acceptCommercial
required |
boolean | Whether commercial cards are accepted. Omitted or null accepts them. A GSA card is judged by
`acceptGsa` alone, so turning this off does not refuse government purchase cards.
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.
| ||||||||
acceptGsa
required |
boolean | Whether GSA (US government purchase) cards are accepted. Omitted or null accepts 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.
| ||||||||
issuerCountryMode
required |
IssuerCountryMode IssuerCountryMode | How the issuer country is judged. Omitted or null means
`Any`, which does not consider the issuer country at all.
Conditional: When IssuerCountryMode is not null.
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.
| ||||||||
issuerCountries
required |
array of string array of | The ISO 3166-1 alpha-2 issuer country codes the mode operates on. Required and non-empty for
`AllowList` and
`DenyList`, and must be empty for
the other two modes.
Conditional: When IssuerCountries is not null.
Conditional: When IssuerCountries is not null and IssuerCountries.Count > 1.
Conditional: When RequiresCountries(IssuerCountryMode) is true.
Conditional: When RequiresCountries(IssuerCountryMode) is 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.
| ||||||||
unknownBinPosture
required |
UnknownBinPosture UnknownBinPosture | What happens when the card's BIN cannot be resolved. Omitted or null means
`Accept`, which is what the
platform has always done.
Conditional: When UnknownBinPosture is not null.
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.