Transaction Details
$transaction->id
Transaction IDs are made up of alpha-numeric characters and are at least 6 characters in length. Example: “gy46fg”
$transaction->avsErrorResponseCode
The AVS error response code will be populated if there was an error when checking AVS. If this is not set then you will have an avsPostalCodeResponseCode and an avsStreetAddressResponseCode.
- S = Issuing bank does not support AVS
- E = AVS system error
- A = Not Applicable
$transaction->avsPostalCodeResponseCode
If there was an error processing AVS this will not be set and instead you will have an avsErrorResponseCode. Otherwise this will populated as one of the following values.
- M = Matches
- N = Does not Match
- U = Not Verified
- I = Not Provided
- A = Not Applicable
$transaction->avsStreetAddressResponseCode
If there was an error processing AVS this will not be set and instead you will have an avsErrorResponseCode. Otherwise this will populated as one of the following values.
- M = Matches
- N = Does not Match
- U = Not Verified
- I = Not Provided
- A = Not Applicable
$transaction->amount
A BigDecimal object for the transaction amount. If you settle a different amount than what was authorized, this will return the amount settled.
$transaction->createdAt
Date/time the transaction was created.
$transaction->creditCardDetails
The credit card details used to process this transaction. If the transaction was created using vault tokens, then the creditCardDetails is a snapshot of the credit card in the vault at the time the transaction was created. So if the credit card in the vault is updated after the transaction is created, $transaction->creditCardDetails->maskedNumber will return the number that was used to process the transaction, while $transaction->vaultCreditCard->maskedNumber will return the current masked number for the token that was used to create the transaction.
$transaction->creditCardDetails->bin
The first 6 digits of the credit card number.
$transaction->creditCardDetails->cardType
The type of the credit card.
- American Express
- Carte Blanche
- China UnionPay
- Diners Club
- Discover
- JCB
- Laser
- Maestro
- MasterCard
- Solo
- Switch
- Visa
- Unknown
$transaction->creditCardDetails->cardholderName
$transaction->creditCardDetails->customerLocation
“US” if the billing address is in the US or not specified. “International” if the billing country is not in the US.
$transaction->creditCardDetails->expirationMonth
Formatted as MM.
$transaction->creditCardDetails->expirationYear
Formatted as YYYY.
$transaction->creditCardDetails->expirationDate
Formatted as MM/YYYY.
$transaction->creditCardDetails->last4
The last four digits of the credit card number.
$transaction->creditCardDetails->token
The vault token for the credit card. This is the only attribute that is not a snapshot. If you update your vault tokens after creating a transaction, this attribute will return the new token rather than what the token was at the time the transaction was created.
$transaction->creditCardDetails->maskedNumber
The credit card number with middle digits masked, e.g. 510510******5100. Currently we always return six asterisks in the middle, even if the actual credit card number isn’t 16-digits long.
$transaction->customerDetails
The customer details used to process this transaction. If the transaction was created using vault tokens, then the customerDetails is a snapshot of the customer in the vault at the time the transaction was created. So if the customer in the vault is updated after the transaction is created, $transaction->customerDetails->firstName will return the first name that was used to process the transaction, while $transaction->vaultCustomer->firstName will return the current first name for the customer that was used to create the transaction.
$transaction->currencyIsoCode
The currency for the transaction. “USD” for US dollars. See the ISO 4217 codes.
$transaction->customFields
A hash of custom fields stored on the transaction.
$transaction->cvvResponseCode
- M = Matches
- N = Does not Match
- U = Not Verified
- I = Not Provided
- A = Not Applicable
$transaction->gatewayRejectionReason
Indicates why the transaction was rejected. Only set if the status is gateway rejected.
- avs
- avs_and_cvv
- cvv
- duplicate
Note: This was added in version 2.4.0
$transaction->merchantAccountId
$transaction->orderId
$transaction->billingDetails
The billing address details used to process this transaction. If billing address was stored in the vault, then the billingAddressDetails is a snapshot of the address in the vault at the time the transaction was created. So if the address in the vault is updated after the transaction is created, $transaction->billingAddressDetails->postalCode will return the postal code, while $transaction->vaultBillingAddress->postalCode will return the current postal code for the address in the vault.
The address details are similar to those found on the address details page.
$transaction->billingDetails->company$transaction->billingDetails->countryCodeAlpha2$transaction->billingDetails->countryCodeAlpha3$transaction->billingDetails->countryCodeNumeric$transaction->billingDetails->countryName$transaction->billingDetails->extendedAddress$transaction->billingDetails->firstName$transaction->billingDetails->lastName$transaction->billingDetails->locality$transaction->billingDetails->postalCode$transaction->billingDetails->region$transaction->billingDetails->streetAddress
$transaction->shippingDetails
Same as $transaction->billingDetails above.
$transaction->processorAuthorizationCode
The authorization code from the processor.
$transaction->processorResponseCode
See the list of possible processor responses.
$transaction->processorResponseText
See the list of possible processor responses.
$transaction->refundIds
If this transaction was refunded, this will return a list of the ids for any transactions that refunded this transaction.
$transaction->refundedTransactionId
If this transaction is a refund, this will return the ID of the sale transaction that was refunded by this one.
$transaction->status
See the transaction overview. Possible values:
- authorized
- processor_declined
- gateway_rejected
- failed
- voided
- submitted_for_settlement
- settled
- settling
- authorization_expired
$transaction->statusHistory
$transaction->subscriptionId
$transaction->subscriptionDetails.billingPeriodStartDate
$transaction->subscriptionDetails.billingPeriodEndDate
$transaction->type
Indicates if the transaction is a sale or a credit. Possible values:
- sale
- credit
$transaction->updatedAt
The timestamp of the latest time the transaction was updated.