Skip to content

Commit 59a0070

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(docs): updates to documentation for V2 AuthRules (#360)
1 parent a89b6f0 commit 59a0070

14 files changed

Lines changed: 2474 additions & 73 deletions

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/AuthRuleV2CreateParams.kt‎

Lines changed: 390 additions & 12 deletions
Large diffs are not rendered by default.

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/AuthRuleV2DraftParams.kt‎

Lines changed: 128 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,38 @@ constructor(
478478

479479
private var validated: Boolean = false
480480

481-
/** The attribute to target */
481+
/**
482+
* The attribute to target.
483+
*
484+
* The following attributes may be targeted:
485+
* - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
486+
* business by the types of goods or services it provides.
487+
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO
488+
* 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands
489+
* Antilles.
490+
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
491+
* transaction.
492+
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
493+
* (merchant).
494+
* - `DESCRIPTOR`: Short description of card acceptor.
495+
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
496+
* applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
497+
* `TOKEN_AUTHENTICATED`.
498+
* - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
499+
* (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
500+
* `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
501+
* `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
502+
* `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
503+
* - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
504+
* fee field in the settlement/cardholder billing currency. This is the amount the
505+
* issuer should authorize against unless the issuer is paying the acquirer fee on
506+
* behalf of the cardholder.
507+
* - `RISK_SCORE`: Network-provided score assessing risk level associated with a
508+
* given authorization. Scores are on a range of 0-999, with 0 representing the
509+
* lowest risk and 999 representing the highest risk. For Visa transactions, where
510+
* the raw score has a range of 0-99, Lithic will normalize the score by
511+
* multiplying the raw score by 10x.
512+
*/
482513
fun attribute(): Optional<Attribute> =
483514
Optional.ofNullable(attribute.getNullable("attribute"))
484515

@@ -488,7 +519,38 @@ constructor(
488519

489520
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
490521

491-
/** The attribute to target */
522+
/**
523+
* The attribute to target.
524+
*
525+
* The following attributes may be targeted:
526+
* - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
527+
* business by the types of goods or services it provides.
528+
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO
529+
* 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands
530+
* Antilles.
531+
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
532+
* transaction.
533+
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
534+
* (merchant).
535+
* - `DESCRIPTOR`: Short description of card acceptor.
536+
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
537+
* applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
538+
* `TOKEN_AUTHENTICATED`.
539+
* - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
540+
* (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
541+
* `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
542+
* `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
543+
* `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
544+
* - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
545+
* fee field in the settlement/cardholder billing currency. This is the amount the
546+
* issuer should authorize against unless the issuer is paying the acquirer fee on
547+
* behalf of the cardholder.
548+
* - `RISK_SCORE`: Network-provided score assessing risk level associated with a
549+
* given authorization. Scores are on a range of 0-999, with 0 representing the
550+
* lowest risk and 999 representing the highest risk. For Visa transactions, where
551+
* the raw score has a range of 0-99, Lithic will normalize the score by
552+
* multiplying the raw score by 10x.
553+
*/
492554
@JsonProperty("attribute") @ExcludeMissing fun _attribute() = attribute
493555

494556
/** The operation to apply to the attribute */
@@ -531,10 +593,72 @@ constructor(
531593
additionalProperties(condition.additionalProperties)
532594
}
533595

534-
/** The attribute to target */
596+
/**
597+
* The attribute to target.
598+
*
599+
* The following attributes may be targeted:
600+
* - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify
601+
* a business by the types of goods or services it provides.
602+
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
603+
* ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
604+
* Netherlands Antilles.
605+
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of
606+
* the transaction.
607+
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
608+
* (merchant).
609+
* - `DESCRIPTOR`: Short description of card acceptor.
610+
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the
611+
* issuer applies to the transaction. Valid values are `NONE`,
612+
* `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
613+
* - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account
614+
* number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`,
615+
* `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`,
616+
* `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`,
617+
* `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
618+
* - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the
619+
* acquirer fee field in the settlement/cardholder billing currency. This is
620+
* the amount the issuer should authorize against unless the issuer is paying
621+
* the acquirer fee on behalf of the cardholder.
622+
* - `RISK_SCORE`: Network-provided score assessing risk level associated with a
623+
* given authorization. Scores are on a range of 0-999, with 0 representing
624+
* the lowest risk and 999 representing the highest risk. For Visa
625+
* transactions, where the raw score has a range of 0-99, Lithic will
626+
* normalize the score by multiplying the raw score by 10x.
627+
*/
535628
fun attribute(attribute: Attribute) = attribute(JsonField.of(attribute))
536629

537-
/** The attribute to target */
630+
/**
631+
* The attribute to target.
632+
*
633+
* The following attributes may be targeted:
634+
* - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify
635+
* a business by the types of goods or services it provides.
636+
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
637+
* ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
638+
* Netherlands Antilles.
639+
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of
640+
* the transaction.
641+
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
642+
* (merchant).
643+
* - `DESCRIPTOR`: Short description of card acceptor.
644+
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the
645+
* issuer applies to the transaction. Valid values are `NONE`,
646+
* `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.
647+
* - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account
648+
* number (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`,
649+
* `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`,
650+
* `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`,
651+
* `UNSPECIFIED`, `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
652+
* - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the
653+
* acquirer fee field in the settlement/cardholder billing currency. This is
654+
* the amount the issuer should authorize against unless the issuer is paying
655+
* the acquirer fee on behalf of the cardholder.
656+
* - `RISK_SCORE`: Network-provided score assessing risk level associated with a
657+
* given authorization. Scores are on a range of 0-999, with 0 representing
658+
* the lowest risk and 999 representing the highest risk. For Visa
659+
* transactions, where the raw score has a range of 0-99, Lithic will
660+
* normalize the score by multiplying the raw score by 10x.
661+
*/
538662
@JsonProperty("attribute")
539663
@ExcludeMissing
540664
fun attribute(attribute: JsonField<Attribute>) = apply {

0 commit comments

Comments
 (0)