Contains information about a specific recurring subscription charge
Request
| Property Name | Type | Required | Description |
|---|---|---|---|
amount | decimal | Create Merchant-Managed Subscription: Required for ACH/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. |
vaultedShopperId | integer | Create Merchant-Managed Subscription: Optional; do not include if sending payerInfo | ID of an existing vaulted shopper. |
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. |
softDescriptor | string | Create Merchant-Managed Subscription: Optional | Description of the transaction, which appears on the shopper's bank statement. Maximum 20 characters. |
descriptorPhoneNumber | string | Create Merchant-Managed Subscription: Optional | Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters. |
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. |
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. |
chargeInfo | object | Create Merchant-Managed Subscription Charge: Optional | Contains chargeInfo properties. |
level3Data | object | Optional | Contains level3Data properties. |
threeDSecure | object | Create Merchant-Managed Subscription: Optional | Contains threeDSecure 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. |
merchantTransactionId | string | Optional | Provides merchant-specific transaction information. 1–50 characters. Special characters are not recommended. |
transactionOrderSource | string | Optional | Identifies the order type. The only option is MOTO (Mail Order Telephone Order). Any other option is ignored. |
Response
| Property Name | Type | Required |
|---|---|---|
chargeId | integer | BlueSnap identifier for the charge. |
subscriptionId | integer | BlueSnap identifier for the subscription. |
planId | integer | BlueSnap identifier for the billing plan. |
vaultedShopperId | integer | ID of the vaulted shopper. |
transactionId | integer | BlueSnap identifier for the transaction. |
transactionDate | 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. |
softDescriptor | string | Description of the transaction, which appears on the shopper's credit card statement. |
paymentSource | object | See paymentSource. |
chargeInfo | object | See chargeInfo. |
processingInfo | object | See processingInfo. |
fraudResultInfo | object | See fraudResultInfo. |
transactionMetaData | object | See transactionMetaData. |
refunds | object | See refunds. |
level3Data | object | See level3Data. |
threeDSecure | object | See threeDSecure. |
merchantTransactionId | string | Merchant-specific transaction information. |