Contains the details 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. |
authorized-by-shopper | 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. |
currency | string | Required | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
ecp-transaction | container | Required for ACH (ECP) transactions if pfToken is not included. | Container of ecp-transaction properties. |
merchant-transaction-id | string | Optional | Merchant's unique ID for a new transaction. Between 1 - 50 characters. Special characters are not recommended. |
payer-info | container | Optional | Container of payer-info properties. For create-lbt-transaction, either the payer-info or the vaulted-shopper-id is required. |
paypal-transaction | container | Required for PayPal transactions. | Container of paypal-transaction properties. |
pf-token | string | Required for ACH (ECP) transactions if you're using the Secured Payment Collector. | Secured Payment Collector token. |
product-description | string | Optional | The product description that will appear in IPNs, emails, and the Control Panel. |
sepa-direct-debit-transaction | container | Required for SEPA Direct Debit transactions | Container of sepa-direct-debit-transaction properties. |
soft-descriptor | string | Optional | Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters. |
sofort-transaction | container | Required for Sofort transactions | Container of sofort-transaction properties. |
tax-reference | string | Optional | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
transaction-description | 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. |
transaction-fraud-info | container | Optional | Container of transaction-fraud-info properties. |
transaction-meta-data | container | Optional | Container of transaction-meta-data properties. |
vaulted-shopper-id | integer | Optional | ID of an existing vaulted shopper. For create-lbt-transaction, either the payer-info or the vaulted-shopper-id is required. |
vendors-info | container | Required for Marketplace vendors | Container of vendors-info properties. |
Response
| Property Name | Type | Description |
|---|---|---|
amount | decimal | Amount to be charged in the transaction, including decimal points. |
currency | string | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
ecp-transaction | container | Container of ecp-transaction properties. |
fraud-result-info | container | Container of fraud-result-info properties. |
merchant-transaction-id | string | Merchant's unique ID for a new transaction. Between 1 - 50 characters. |
payer-info | container | Container of payer-info properties. |
paypal-transaction | container | Container of paypal-transaction properties. \nRelevant only for PayPal transactions. |
processing-info | container | Container of processing-info properties. |
refunds | container | Container of refunds properties. |
sepa-direct-debit-transaction | container | Container of sepa-direct-debit-transaction properties. |
sofort-transaction | container | Container of sofort-transaction properties. |
soft-descriptor | string | Description of the transaction, which appears on the customer's credit card statement. |
subscription-id | integer | BlueSnap identifier for the subscription. |
tax-reference | string | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
transaction-approval-date | string | The date the transaction was approved. |
transaction-approval-time | string | The time the transaction was approved. This is in Pacific time. |
transaction-id | string | BlueSnap identifier for the transaction. |
transaction-meta-data | container | Container of transaction-meta-data properties. |
vaulted-shopper-id | integer | ID of an existing vaulted shopper. |
vendors-info | container | Container of vendors-info properties. |