CardPaymentDetails

December 17, 2019 ยท View on GitHub

Description

Reflects the current status of a card payment.

Properties

NameGetterSetterTypeDescriptionNotes
statusgetStatus()setStatus($value)stringThe card payment's current state. It can be one of: `AUTHORIZED`, `CAPTURED`, `VOIDED`, `FAILED`.[optional]
cardgetCard()setCard($value)\SquareConnect\Model\CardThe credit card's non-confidential details.[optional]
entry_methodgetEntryMethod()setEntryMethod($value)stringThe method used to enter the card's details for the payment. Can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.[optional]
cvv_statusgetCvvStatus()setCvvStatus($value)stringStatus code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`.[optional]
avs_statusgetAvsStatus()setAvsStatus($value)stringStatus code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`.[optional]
auth_result_codegetAuthResultCode()setAuthResultCode($value)stringStatus code returned by the card issuer that describes the payment's authorization status.[optional]
application_identifiergetApplicationIdentifier()setApplicationIdentifier($value)stringFor EMV payments, identifies the EMV application used for the payment.[optional]
application_namegetApplicationName()setApplicationName($value)stringFor EMV payments, the human-readable name of the EMV application used for the payment.[optional]
application_cryptogramgetApplicationCryptogram()setApplicationCryptogram($value)stringFor EMV payments, the cryptogram generated for the payment.[optional]
verification_methodgetVerificationMethod()setVerificationMethod($value)stringFor EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.[optional]
verification_resultsgetVerificationResults()setVerificationResults($value)stringFor EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`.[optional]
statement_descriptiongetStatementDescription()setStatementDescription($value)stringThe 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.[optional]
device_detailsgetDeviceDetails()setDeviceDetails($value)\SquareConnect\Model\DeviceDetailsDetails about the device that took the payment.[optional]
errorsgetErrors()setErrors($value)\SquareConnect\Model\Error[]Information on errors encountered during the request.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]