• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

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. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.

Max Length 50
card
Card

The credit card's non-confidential details.

entry_method
string

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

Max Length 50
cvv_status
string

The status code returned from the Card Verification Value (CVV) check. The code can be CVV_ACCEPTED, CVV_REJECTED, or CVV_NOT_CHECKED.

Max Length 50
avs_status
string

The status code returned from the Address Verification System (AVS) check. The code can be AVS_ACCEPTED, AVS_REJECTED, or AVS_NOT_CHECKED.

Max Length 50
auth_result_code
string

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

Max Length 10
application_identifier
string

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

Max Length 32
application_name
string

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

Max Length 16
application_cryptogram
string

For EMV payments, the cryptogram generated for the payment.

Max Length 16
verification_method
string

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.

Max Length 50
verification_results
string

For EMV payments, the results of the cardholder verification. The result can be SUCCESS, FAILURE, or UNKNOWN.

Max Length 50
statement_description
string

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.

Max Length 50
device_details
DeviceDetails

Details about the device that took the payment.

refund_requires_card_presence
boolean

Beta

Whether the card must be physically present for the payment to be refunded. If set to true, the card must be present.

errors
Error [ ]

Information about errors encountered during the request.

Share Feedback

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