Transaction Details

transaction.id

Transaction IDs are made up of alpha-numeric characters and are at least 6 characters in length. Example: “gy46fg”

transaction.avs_error_response_code

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 avs_postal_code_response_code and an avs_street_address_response_code.

transaction.avs_postal_code_response_code

If there was an error processing AVS this will not be set and instead you will have an avs_error_response_code. Otherwise this will populated as one of the following values.

transaction.avs_street_address_response_code

If there was an error processing AVS this will not be set and instead you will have an avs_error_response_code. Otherwise this will populated as one of the following values.

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.created_at

Date/time the transaction was created.

transaction.credit_card_details

The credit card details used to process this transaction. If the transaction was created using vault tokens, then the credit_card_details 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.credit_card_details.masked_number will return the number that was used to process the transaction, while transaction.vault_credit_card.masked_number will return the current masked number for the token that was used to create the transaction.

transaction.credit_card_details.bin

The first 6 digits of the credit card number.

transaction.credit_card_details.card_type

The type of the credit card.

transaction.credit_card_details.cardholder_name

transaction.credit_card_details.customer_location

“US” if the billing address is in the US or not specified. “International” if the billing country is not in the US.

transaction.credit_card_details.expiration_month

Formatted as MM.

transaction.credit_card_details.expiration_year

Formatted as YYYY.

transaction.credit_card_details.expiration_date

Formatted as MM/YYYY.

transaction.credit_card_details.last_4

The last four digits of the credit card number.

transaction.credit_card_details.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.credit_card_details.masked_number

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.customer_details

The customer details used to process this transaction. If the transaction was created using vault tokens, then the customer_details 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.customer_details.first_name will return the first name that was used to process the transaction, while transaction.vault_customer.first_name will return the current first name for the customer that was used to create the transaction.

transaction.currency_iso_code

The currency for the transaction. “USD” for US dollars. See the ISO 4217 codes.

transaction.custom_fields

A hash of custom fields stored on the transaction.

transaction.cvv_response_code

transaction.gateway_rejection_reason

Indicates why the transaction was rejected. Only set if the status is gateway rejected.

Note: This was added in version 2.4.0

transaction.merchant_account_id

transaction.order_id

transaction.billing_details

The billing address details used to process this transaction. If billing address was stored in the vault, then the billing_address_details 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.billing_address_details.postal_code will return the postal code, while transaction.vault_billing_address.postal_code 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.shipping_details

Same as transaction.billing_details above.

transaction.processor_authorization_code

The authorization code from the processor.

transaction.processor_response_code

See the list of possible processor responses.

transaction.processor_response_text

See the list of possible processor responses.

transaction.refund_ids

If this transaction was refunded, this will return a list of the ids for any transactions that refunded this transaction.

transaction.refunded_transaction_id

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:

transaction.status_history

transaction.subscription_id

transaction.subscription_details.billing_period_start_date

transaction.subscription_details.billing_period_end_date

transaction.type

Indicates if the transaction is a sale or a credit. Possible values:

transaction.updated_at

The timestamp of the latest time the transaction was updated.

transaction.vault_billing_address

transaction.vault_credit_card

transaction.vault_customer

transaction.vault_shipping_address