Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 3.93 KB

card-payment-details.md

File metadata and controls

53 lines (44 loc) · 3.93 KB
Raw

Card Payment Details

Reflects the current status of a card payment. Contains only non-confidential information.

Structure

CardPaymentDetails

Fields

Name Type Tags Description
status string | undefined Optional The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or
FAILED.
Constraints: Maximum Length: 50
card Card | undefined Optional Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK.
entryMethod string | undefined Optional The method used to enter the card's details for the payment. The method can be
KEYED, SWIPED, EMV, ON_FILE, or CONTACTLESS.
Constraints: Maximum Length: 50
cvvStatus string | undefined Optional The status code returned from the Card Verification Value (CVV) check. The code can be
CVV_ACCEPTED, CVV_REJECTED, or CVV_NOT_CHECKED.
Constraints: Maximum Length: 50
avsStatus string | undefined Optional The status code returned from the Address Verification System (AVS) check. The code can be
AVS_ACCEPTED, AVS_REJECTED, or AVS_NOT_CHECKED.
Constraints: Maximum Length: 50
authResultCode string | undefined Optional The status code returned by the card issuer that describes the payment's
authorization status.
Constraints: Maximum Length: 10
applicationIdentifier string | undefined Optional For EMV payments, the application ID identifies the EMV application used for the payment.
Constraints: Maximum Length: 32
applicationName string | undefined Optional For EMV payments, the human-readable name of the EMV application used for the payment.
Constraints: Maximum Length: 16
applicationCryptogram string | undefined Optional For EMV payments, the cryptogram generated for the payment.
Constraints: Maximum Length: 16
verificationMethod string | undefined Optional For EMV payments, the method used to verify the cardholder's identity. The method can be
PIN, SIGNATURE, PIN_AND_SIGNATURE, ON_DEVICE, or NONE.
Constraints: Maximum Length: 50
verificationResults string | undefined Optional For EMV payments, the results of the cardholder verification. The result can be
SUCCESS, FAILURE, or UNKNOWN.
Constraints: Maximum Length: 50
statementDescription string | undefined Optional The statement description sent to the card networks.

Note: The actual statement description varies and is likely to be truncated and appended with
additional information on a per issuer basis.
Constraints: Maximum Length: 50
deviceDetails DeviceDetails | undefined Optional Details about the device that took the payment.
cardPaymentTimeline CardPaymentTimeline | undefined Optional The timeline for card payments.
refundRequiresCardPresence boolean | undefined Optional Whether the card must be physically present for the payment to
be refunded. If set to true, the card must be present.
errors Error[] | undefined Optional Information about errors encountered during the request.

Example (as JSON)

{
  "status": null,
  "card": null,
  "entry_method": null,
  "cvv_status": null,
  "avs_status": null,
  "auth_result_code": null,
  "application_identifier": null,
  "application_name": null,
  "application_cryptogram": null,
  "verification_method": null,
  "verification_results": null,
  "statement_description": null,
  "device_details": null,
  "card_payment_timeline": null,
  "refund_requires_card_presence": null,
  "errors": null
}