charge

amount

decimal

Create Merchant-Managed Subscription:

• *Required** for ACH/ECP and SEPA Direct Debit; optional otherwise

Create Merchant-Managed Subscription Charge:
Required

Charge amount.

authorizedByShopper

boolean

Create Merchant-Managed Subscription:

• *Required** for ACH/ECP and SEPA Direct Debit

Value must be true.

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

chargeInfo

object

Create Merchant-Managed Subscription Charge:
Optional

Contains chargeInfo properties.

currency

string

Required

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

descriptorPhoneNumber

string

Create Merchant-Managed Subscription:
Optional

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

level3Data

object

Optional

Contains level3Data properties.

merchantTransactionId

string

Optional

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

payerInfo

object

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

Contains payerInfo properties.

paymentSource

object

Create Merchant-Managed Subscription:

• *Required** for payerInfo; optional for vaultedShopperId

Contains paymentSource 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.

softDescriptor

string

Create Merchant-Managed Subscription:
Optional

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

threeDSecure

object

Create Merchant-Managed Subscription:
Optional

Contains threeDSecure properties.

transactionFraudInfo

object

Create Merchant-Managed Subscription:
Optional

Contains transactionFraudInfo properties.

transactionMetaData

object

Create Merchant-Managed Subscription
Create Merchant-Managed Subscription Charge:
Optional

Contains transactionMetaData properties.

transactionOrderSource

string

Optional

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

vaultedShopperId

integer

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

ID of an existing vaulted shopper.

amount

decimal

Charge amount.

chargeId

integer

BlueSnap identifier for the charge.

chargeInfo

object

See chargeInfo.

currency

string

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

fraudResultInfo

object

See fraudResultInfo.

level3Data

object

See level3Data.

merchantTransactionId

string

Merchant-specific transaction information.

paymentSource

object

See paymentSource.

planId

integer

BlueSnap identifier for the billing plan.

processingInfo

object

See processingInfo.

refunds

object

See refunds.

softDescriptor

string

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

subscriptionId

integer

BlueSnap identifier for the subscription.

threeDSecure

object

See threeDSecure.

transactionDate

string

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

For example: "2017-07-21"

transactionId

integer

BlueSnap identifier for the transaction.

transactionMetaData

object

See transactionMetaData.

vaultedShopperId

integer

ID of the vaulted shopper.