alt-transaction

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

Request

Property NameTypeRequiredDescription
merchant-transaction-idstringOptionalMerchant's unique ID for a new transaction. Between 1 - 50 characters. Special characters are not recommended.
soft-descriptorstringOptionalDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
amountdecimalRequiredAmount to be charged in the transaction, including decimal points.

Note: The maximum limit for SEPA Direct Debit transactions is 24,999 EUR.
currencystringRequiredCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
tax-referencestringOptionalUnique ID for the tax quote. Refer to the Taxes guide for further details.
vendors-infocontainerRequired for Marketplace vendorsContainer of vendors-info properties.
payer-infocontainerOptionalContainer of payer-info properties.
For create-lbt-transaction, either the payer-info or the vaulted-shopper-id is required.
vaulted-shopper-idintegerOptionalID of an existing vaulted shopper.
For create-lbt-transaction, either the payer-info or the vaulted-shopper-id is required.
paypal-transactioncontainerRequired for PayPal transactions.Container of paypal-transaction properties.
pf-tokenstringRequired for ACH (ECP) transactions if you're using the Secured Payment Collector.Secured Payment Collector token.
ecp-transactioncontainerRequired for ACH (ECP) transactions if pfToken is not included.Container of ecp-transaction properties.
sepa-direct-debit-transactioncontainerRequired for SEPA Direct Debit transactionsContainer of sepa-direct-debit-transaction properties.
local-bank-transfer-transactioncontainerRequired for LBT transactionsContainer of local-bank-transfer-transaction properties.
ideal-transactioncontainerRequired for iDEAL transactionsContainer of ideal-transaction properties.
sofort-transactioncontainerRequired for Sofort transactionsContainer of sofort-transaction properties.
authorized-by-shopperbooleanRequired 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.
transaction-descriptionstringOptional

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.
transaction-meta-datacontainerOptionalContainer of transaction-meta-data properties.
transaction-fraud-infocontainerOptionalContainer of transaction-fraud-info properties.
product-descriptionstringOptionalThe product description that will appear in IPNs, emails, and the Control Panel.

Response

Property NameTypeDescription
merchant-transaction-idstringMerchant's unique ID for a new transaction. Between 1 - 50 characters.
subscription-idintegerBlueSnap identifier for the subscription.
transaction-idstringBlueSnap identifier for the transaction.
soft-descriptorstringDescription of the transaction, which appears on the customer's credit card statement.
amountdecimalAmount to be charged in the transaction, including decimal points.
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
tax-referencestringUnique ID for the tax quote. Refer to the Taxes guide for further details.
vendors-infocontainerContainer of vendors-info properties.
transaction-approval-datestringThe date the transaction was approved.
transaction-approval-timestringThe time the transaction was approved. This is in Pacific time.
payer-infocontainerContainer of payer-info properties.
vaulted-shopper-idintegerID of an existing vaulted shopper.
paypal-transactioncontainerContainer of paypal-transaction properties.
Relevant only for PayPal transactions.
ecp-transactioncontainerContainer of ecp-transaction properties.
sepa-direct-debit-transactioncontainerContainer of sepa-direct-debit-transaction properties.
local-bank-transfer-transactioncontainerContainer of local-bank-transfer-transaction properties.
ideal-transactioncontainerContainer of ideal-transaction properties.
sofort-transactioncontainerContainer of sofort-transaction properties.
transaction-meta-datacontainerContainer of transaction-meta-data properties.
processing-infocontainerContainer of processing-info properties.
fraud-result-infocontainerContainer of fraud-result-info properties.
refundscontainerContainer of refunds properties.