Object Index / Definition

You are viewing an old version of the API
CardPaymentDetails

Reflects the current status of a card payment.

Properties

Name Description
status
string

The card payment's current state. It can be one of: AUTHORIZED, CAPTURED, VOIDED, FAILED.

card
Card

The credit card's non-confidential details.

entry_method
string

The method used to enter the card's details for the payment. Can be KEYED, SWIPED, EMV, ON_FILE, or CONTACTLESS.

cvv_status
string

Status code returned from the Card Verification Value (CVV) check. Can be CVV_ACCEPTED, CVV_REJECTED, CVV_NOT_CHECKED.

avs_status
string

Status code returned from the Address Verification System (AVS) check. Can be AVS_ACCEPTED, AVS_REJECTED, AVS_NOT_CHECKED.

auth_result_code
string

Status code returned by the card issuer that describes the payment's authorization status.

application_identifier
string

For EMV payments, identifies the EMV application used for the payment.

application_name
string

For EMV payments, the human-readable name of the EMV application used for the payment.

application_cryptogram
string

For EMV payments, the cryptogram generated for the payment.

verification_method
string

For EMV payments, method used to verify the cardholder's identity. Can be one of PIN, SIGNATURE, PIN_AND_SIGNATURE, ON_DEVICE, or NONE.

verification_results
string

For EMV payments, the results of the cardholder verification. Can be one of SUCCESS, FAILURE, or UNKNOWN.

statement_description
string

The statement description sent to the card networks.

Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis.

device_details
DeviceDetails

Details about the device that took the payment.

errors
Error [ ]

Information on errors encountered during the request.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?