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.
currencystringRequiredCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
vaultedShopperIdintegerCreate Merchant-Managed Subscription:
Optional; do not include if sending payerInfo
ID of an existing vaulted shopper.
payerInfoobjectCreate Merchant-Managed Subscription:
Optional; do not include if sending vaultedShopperId
Contains payerInfo properties.
paymentSourceobjectCreate Merchant-Managed Subscription:
Required for payerInfo; optional for vaultedShopperId
Contains paymentSource properties.
softDescriptorstringCreate Merchant-Managed Subscription:
Optional
Description of the transaction, which appears on the shopper's bank statement. Maximum 20 characters.
descriptorPhoneNumberstringCreate Merchant-Managed Subscription:
Optional
Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters.
authorizedByShopperbooleanCreate 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.
transactionFraudInfoobjectCreate Merchant-Managed Subscription:
Optional
Contains transactionFraudInfo properties.
transactionMetaDataobjectCreate Merchant-Managed Subscription
Create Merchant-Managed Subscription Charge:
Optional
Contains transactionMetaData properties.
chargeInfoobjectCreate Merchant-Managed Subscription Charge:
Optional
Contains chargeInfo properties.
level3DataobjectOptionalContains level3Data properties.
threeDSecureobjectCreate Merchant-Managed Subscription:
Optional
Contains threeDSecure properties.
scheduledbooleanCreate Merchant-Managed Subscription Charge:
Optional
Value can be true or false.

Pass this parameter to identify that the transaction is a regularly scheduled event.
merchantTransactionIdstringOptionalProvides merchant-specific transaction information. 1–50 characters. Special characters are not recommended.
transactionOrderSourcestringOptionalIdentifies the order type.
The only option is MOTO  (Mail Order Telephone Order).
Any other option is ignored.

Response

Property NameTypeRequired
chargeIdintegerBlueSnap identifier for the charge.
subscriptionIdintegerBlueSnap identifier for the subscription.
planIdintegerBlueSnap identifier for the billing plan.
vaultedShopperIdintegerID of the vaulted shopper.
transactionIdintegerBlueSnap identifier for the transaction.
transactionDatestringDate (yyyy-mm-dd) of the transaction.

For example: "2017-07-21"
amountdecimalCharge amount.
currencystringCurrency code (ISO 4217) of the charge. See Currency codes.
softDescriptorstringDescription of the transaction, which appears on the shopper's credit card statement.
paymentSourceobjectSee paymentSource.
chargeInfoobjectSee chargeInfo.
processingInfoobjectSee processingInfo.
fraudResultInfoobjectSee fraudResultInfo.
transactionMetaDataobjectSee transactionMetaData.
refundsobjectSee refunds.
level3DataobjectSee level3Data.
threeDSecureobjectSee threeDSecure.
merchantTransactionIdstringMerchant-specific transaction information.