charge

Contains information about a specific recurring subscription charge

Request

Property NameTypeRequiredDescription
amountdecimalCreate Merchant-Managed Subscription: Required for ACH/ECP and SEPA Direct Debit; optional otherwise

Create Merchant-Managed Subscription Charge: Required
Charge amount.
authorizedByShopperbooleanCreate Merchant-Managed Subscription: Required for ACH/ECP and SEPA Direct DebitValue must be true.Pass this parameter to indicate that you have obtained the shopper's permission to debit their account.
chargeInfoobjectCreate Merchant-Managed Subscription Charge: OptionalContains chargeInfo properties.
currencystringRequiredCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
descriptorPhoneNumberstringCreate Merchant-Managed Subscription: OptionalMerchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters.
level3DataobjectOptionalContains level3Data properties.
merchantTransactionIdstringOptionalProvides merchant-specific transaction information. 1–50 characters. Special characters are not recommended.
payerInfoobjectCreate Merchant-Managed Subscription: Optional; do not include if sending vaultedShopperIdContains payerInfo properties.
paymentSourceobjectCreate Merchant-Managed Subscription: Required for payerInfo; optional for vaultedShopperIdContains paymentSource properties.
scheduledbooleanCreate Merchant-Managed Subscription Charge: OptionalValue can be true or false.

Pass this parameter to identify that the transaction is a regularly scheduled event.
shippingContactInfoobjectCreate Merchant-Managed Subscription and Create Merchant-Managed Subscription Charge: Optional

Details for the shipping contact. Refer to shippingContactInfo.

To update shipping contact information after the initial Create call, use the Vaulted Shopper API instead.

softDescriptorstringCreate Merchant-Managed Subscription: OptionalDescription of the transaction, which appears on the shopper's bank statement. Maximum 20 characters.
threeDSecureobjectCreate Merchant-Managed Subscription: OptionalContains threeDSecure properties.
transactionFraudInfoobjectCreate Merchant-Managed Subscription: OptionalContains transactionFraudInfo properties.
transactionMetaDataobjectCreate Merchant-Managed Subscription and Create Merchant-Managed Subscription Charge: OptionalContains transactionMetaData properties.
transactionOrderSourcestringOptionalIdentifies the order type. The only option is MOTO  (Mail Order Telephone Order). Any other option is ignored.
vaultedShopperIdintegerCreate Merchant-Managed Subscription: Optional; do not include if sending payerInfoID of an existing vaulted shopper.

Response

Property NameTypeRequired
amountdecimalCharge amount.
chargeIdintegerBlueSnap identifier for the charge.
chargeInfoobjectSee chargeInfo.
currencystringCurrency code (ISO 4217) of the charge. See Currency codes.
fraudResultInfoobjectSee fraudResultInfo.
level3DataobjectSee level3Data.
merchantTransactionIdstringMerchant-specific transaction information.
paymentSourceobjectSee paymentSource.
planIdintegerBlueSnap identifier for the billing plan.
processingInfoobjectSee processingInfo.
refundsobjectSee refunds.
shippingContactInfoobjectSee shippingContactInfo.
softDescriptorstringDescription of the transaction, which appears on the shopper's credit card statement.
subscriptionIdintegerBlueSnap identifier for the subscription.
threeDSecureobjectSee threeDSecure.
transactionDatestring

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

For example: "2017-07-21"

transactionIdintegerBlueSnap identifier for the transaction.
transactionMetaDataobjectSee transactionMetaData.
vaultedShopperIdintegerID of the vaulted shopper.