charge

Contains information about a specific recurring subscription charge

Request

Property Name

Type

Required

Description

amount

decimal

Create Merchant-Managed Subscription:

Required for ACHP/ECP and SEPA Direct Debit; optional otherwise

Create Merchant-Managed Subscription Charge: Required

Charge amount.

authorized-by-shopper

boolean

Create Merchant-Managed Subscription:

Required for SEPA Direct Debit

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

charge-info

container

Create Merchant-Managed Subscription Charge: Optional

Container of charge-info properties.

currency

string

Required

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

descriptor-phone-number

string

Create Merchant-Managed Subscription: Optional

Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters.

level-3-data

container

Optional

Container of level-3-data properties.

merchant-transaction-id

string

Optional

Provides merchant-specific transaction information. 1–50 characters. Special characters are not recommended.

payer-info

container

Create Merchant-Managed Subscription: Optional; do not include if sending vaulted-shopper-id

Container of payer-info properties.

payment-source

container

Create Merchant-Managed Subscription: Required for payer-info; optional for vaulted-shopper-id

Container of payment-source properties.

scheduled

boolean

Create Merchant-Managed Subscription Charge: Optional

Value can be true or false.
Pass this parameter to identify that the transaction is a regularly scheduled event.

soft-descriptor

string

Create Merchant-Managed Subscription: Optional

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

three-d-secure

container

Create Merchant-Managed Subscription: Optional

Container of three-d-secure properties.

transaction-fraud-info

container

Create Merchant-Managed Subscription: Optional

Container of transaction-fraud-info properties.

transaction-meta-data

container

Create Merchant-Managed Subscription

Create Merchant-Managed Subscription Charge: Optional

Container of transaction-meta-data properties.

transaction-order-source

string

Optional

Identifies the order type. The only option is MOTO (Mail Order Telephone Order). Any other option is ignored.

vaulted-shopper-id

integer

Create Merchant-Managed Subscription: Optional; do not include if sending payer-info

ID of an existing vaulted shopper.


Response

Property NameTypeDescription
amountdecimalCharge amount.
charge-idintegerBlueSnap identifier for the charge.
charge-infocontainerContainer of charge-info properties.
currencystringCurrency code (ISO 4217) of the charge. See Currency codes.
fraud-result-infocontainerContainer of fraud-result-info properties.
level-3-datacontainerContainer of level-3-data properties.
merchant-transaction-idstringMerchant-specific transaction information.
payment-sourcecontainerContainer of payment-source properties.
plan-idintegerBlueSnap identifier for the billing plan.
processing-infocontainerContainer of processing-info properties.
refundscontainerContainer of refunds properties.
soft-descriptorstringDescription of the transaction, which appears on the shopper's credit card statement.
subscription-idintegerBlueSnap identifier for the subscription.
three-d-securecontainerContainer of three-d-secure properties.
transaction-datestringDate (yyyy-mm-dd) of the transaction. For example: \"2017-07-21\"
transaction-idstringBlueSnap identifier for the transaction.
transaction-meta-datacontainerContainer of transaction-meta-data properties.
vaulted-shopper-idintegerID of the vaulted shopper.