TransactionStatus Subobject

Lists the current Status for the Transaction. Note: This subobject is required for the AutoBill and Transaction.migrate calls. With these calls, you must record at least one TransactionStatus object, with the time stamp and a status of Cancelled, Captured, or Settled.

Data Members	Data Type	Description
`amazonStatus`	`TransactionStatus Amazon`	Status details for an Amazon Transaction.
`authCodeDescription`	enum	An enumerated string that specifies the authorization code description based on either the payment provider definition or the merchant override for an `auth` code. Values can be `Soft failure` or `Hard failure` Note: If a payment provider response is overridden in the merchant configuration, the note field for that specific transaction contains the string “Auth Code Override”.
`boletoStatus`	`TransactionStatus Boleto`	The status of a Boleto Bancário-based transaction. This field is populated with the `uri` received for this Transaction (the URL your payment processor received in response to a presentment of the fiscal number for the Transaction). Note: Subscribe does not support the Boleto Payment method for migrated Transactions. See the TransactionStatusBoleto Subobject .
`carrierBillingStatus`	`TransactionStatus CarrierBilling`	The status for a Carrier Billing based Transaction. This object contains two data members: - `authCode`: Result code for the requested action. - `buyUrl`: URL which (when sourced on a customer’s browser) generates HTML elements to facilitate processing of a `CarrierBilling` payment. Note: Subscribe does not support the Carrier Billing payment method for migrated Transactions.
`creditCardStatus`	`TransactionStatus CreditCard`	The most recently returned status of the credit-card-based transaction. For migrated Transactions, populate this field with the payment-processor-specific details, such as the authorization code. When reporting transactions to Vindicia for ChargeGuard, specify this attribute to help Vindicia dispute chargebacks. See the TransactionStatusCreditCard Subobject .
`directDebit-Status`	`TransactionStatus DirectDebit`	(This data member is not in use.)
`ecpStatus`	`TransactionStatus ECP`	The status of an ECP-based transaction. For migrated Transactions, populate this field with the most recent status received from your Payment Processor. When reporting transactions to Vindicia for ChargeGuard, specify this attribute, to help Vindicia dispute chargebacks. See the TransactionStatusECP Subobject.
`extendedVerification`	`ExtendedVerification Response`	The Payment Provider’s response to a request for extended verification. Often this will require merchants to redirect the customer to a URL. See the ExtendedVerificationResponse Subobject.
`fundingSourceBalance`	decimal	The outstanding available balance on the submitted `PaymentMethod`.
`hostedPageStatus`	`TransactionStatus HostedPage`	Status details for a HostedPage Transaction. Note: The customer’s Account must exist before any Hosted Page related call references that Account. See the TransactionStatusHostedPage Subobject.
`paymentMethodType`	`PaymentMethodType`	Optional. The type of payment method for this `Transaction` object. Depending on this value, you must also populate other `TransactionStatus` data members. For example, if you set the value of this data member to `CreditCard`, you must also populate the `creditCard` data member with the appropriate information. If no value is entered for this data member with a `Transaction` or `AutoBill.migrate` call, Subscribe will automatically populate it based on the `MigrationTransaction` object’s `paymentMethod` data member. See the PaymentMethodType Subobject .
`payPalStatus`	`TransactionStatus PayPal`	The status of a PayPal-based transaction. For one-time transactions, included in this attribute is the URL you must present to your customer for a visit to PayPal’s site to complete the transaction process. See the TransactionStatusPayPal Subobject.
`skrillStatus`	`TransactionStatus Skrill`	Status details for a Skrill Transaction.
`status`	`TransactionStatus Type`	An enumerated string that specifies the transaction status. For transactions processed through Subscribe, this status is Vindicia’s interpretation of a specific reason code received from your payment processor. Reason codes from payment processors vary from processor to processor, and are numerous. For one-time transactions, check this value in the `Transaction` object returned to you in response to your call to ensure that the processor has authorized the transaction. See the TransactionStatusType Subobject.
`timestamp`	`dateTime`	A time stamp that specifies the date and time of when the `Transaction` status changed. Required for migrated `Transactions`.
`vinAVS`	`AVSMatchType`	For transactions processed by Subscribe, this value is Vindicia’s interpretation of the AVS code returned by your payment processor. For this field to be valid, you must enable AVS with your payment processor. See the AVSMatchType Subobject .
Parent topic:Transaction Subobjects

Home

Guides

APIs