altTransaction

Contains the information required to process a transaction with an alternative payment method

Request

Property Name

Type

Required

Description

amount

decimal

Required

Amount to be charged in the transaction, including decimal points.

Note: The maximum limit for SEPA Direct Debit transactions is 24,999 EUR.

payerInfo

object

Optional

See payerInfo.

vaultedShopperId

integer

Optional

ID of an existing vaulted shopper.

merchantTransactionId

string

Optional

Merchant's unique ID for a new transaction. Between 1-50 characters. Special characters are not recommended.

softDescriptor

string

Optional

Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.

transactionDescription

string

Optional

Applicable to PayPal transactions.

PayPal transactions By default, the PayPal page will show the statement descriptor as the description of the product being purchased. If you prefer to show a different description, you can send it in this element.

Can be up to 500 characters.

currency

string

Required

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

taxReference

string

Optional

Unique ID for the tax quote. Refer to the Taxes guide for further details.

vendorsInfo

object

Required for Marketplace vendors.

See vendorsInfo.

transactionMetaData

object

Optional

See transactionMetaData.

transactionFraudInfo

object

Optional

See transactionFraudInfo.

paypalTransaction

object

Required for PayPal transactions.

See paypalTransaction.

pfToken

string

Required for ACH (ECP) transactions if you're using the Secured Payment Collector.

Secured Payment Collector token.

ecpTransaction

object

Required for ACH (ECP) transactions if pfToken is not included.

See ecpTransaction.

sepaDirectDebitTransaction

object

Required for SEPA Direct Debit transactions

See sepaDirectDebitTransaction.

localBankTransferTransaction

object

Required for Local Bank Transfer (LBT) transactions

See localBankTransferTransaction

idealTransaction

object

Required for iDEAL transactions

See idealTransaction.

sofortTransaction

object

Required for Sofort transactions

See sofortTransaction.

authorizedByShopper

boolean

Required for ACH (ECP) and SEPA Direct Debit transactions.

Value must be true.

Pass this parameter to indicate that you have obtained the shopper's permission to debit their account.

For ACH transactions, you must obtain permission from the shopper to debit their account, for example by showing a checkbox with the following wording on your checkout page. "I authorize this Electronic Check (ACH) transaction and agree to this debit of my account."

For SEPA Direct Debit transactions, you must obtain the shopper's acceptance of the SEPA Direct Debit Mandate.

becsDirectDebit Transaction

object

Required for BECS Direct Debit Transaction

See becsDirectDebitTransaction.

acssDirectDebitTransaction

object

Required for Pre-Authorized Debit Transaction

See acssDirectDebitTransaction.

Response

Property Name

Type

Description

amount

decimal

Amount to be charged in the transaction, including decimal points.

payerInfo

object

See payerInfo.

vaultedShopperId

integer

ID of an existing vaulted shopper.

merchantTransactionId

string

Merchant's unique ID for a new transaction.

processingInfo

object

See processingInfo.

softDescriptor

string

Description of the transaction, which appears on the customer's credit card statement.

currency

string

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

taxReference

string

Unique ID for the tax quote. Refer to the Taxes guide for further details.

vendorsInfo

object

See vendorsInfo.

transactionApprovalDate

string

The date the transaction was approved.

transactionApprovalTime

string

The time the transaction was approved. This is in Pacific time.

transactionMetaData

object

See transactionMetaData.

fraudResultInfo

object

See fraudResultInfo.

subscriptionId

integer

BlueSnap identifier for the subscription.

transactionId

string

BlueSnap identifier for the transaction.

paypalTransaction

object

See paypalTransaction. Relevant only for PayPal transactions.

ecpTransaction

object

See ecpTransaction.

sepaDirectDebitTransaction

object

See sepaDirectDebitTransaction.

idealTransaction

object

See idealTransaction.

sofortTransaction

object

See sofortTransaction.

refunds

object

See refunds.