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.

currency

string

Required

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

vaulted-shopper-id

integer

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

ID of an existing vaulted shopper.

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.

soft-descriptor

string

Create Merchant-Managed Subscription: Optional

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

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.

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.

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.

charge-info

container

Create Merchant-Managed Subscription Charge: Optional

Container of charge-info properties.

level-3-data

container

Optional

Container of level-3-data 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.

merchant-transaction-id

string

Optional

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

transaction-order-source

string

Optional

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

Response

Property Name

Type

Description

charge-id

integer

BlueSnap identifier for the charge.

subscription-id

integer

BlueSnap identifier for the subscription.

plan-id

integer

BlueSnap identifier for the billing plan.

vaulted-shopper-id

integer

ID of the vaulted shopper.

transaction-id

string

BlueSnap identifier for the transaction.

transaction-date

string

Date (yyyy-mm-dd) of the transaction.

For example: "2017-07-21"

amount

decimal

Charge amount.

currency

string

Currency code (ISO 4217) of the charge. See Currency codes.

soft-descriptor

string

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

payment-source

container

Container of payment-source properties.

charge-info

container

Container of charge-info properties.

processing-info

container

Container of processing-info properties.

fraud-result-info

container

Container of fraud-result-info properties.

transaction-meta-data

container

Container of transaction-meta-data properties.

refunds

container

Container of refunds properties.

three-d-secure

container

Container of three-d-secure properties.

level-3-data

container

Container of level-3-data properties.

merchant-transaction-id

string

Merchant-specific transaction information.