{"_id":"5b196f345952df0003e8a60e","category":{"_id":"5b196f335952df0003e8a5df","version":"5b196f345952df0003e8a66c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5b196f345952df0003e8a66c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5adf4bc1bfc2320003a36617","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5b196f335952df0003e8a5d4","5b196f335952df0003e8a5d5","5b196f335952df0003e8a5d6","5b196f335952df0003e8a5d7","5b196f335952df0003e8a5d8","5b196f335952df0003e8a5d9","5b196f335952df0003e8a5da","5b196f335952df0003e8a5db","5b196f335952df0003e8a5dc","5b196f335952df0003e8a5dd","5b196f335952df0003e8a5de","5b196f335952df0003e8a5df","5b196f335952df0003e8a5e0","5b196f335952df0003e8a5e1","5b196f335952df0003e8a5e2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-28T19:25:37.058Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`amount`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"*Create Merchant-Managed Subscription:*\\n**Required** for ACH/ECP and SEPA Direct Debit; optional otherwise\\n\\n*Create Merchant-Managed Subscription Charge:* \\n**Required**\",\n    \"1-0\": \"`currency`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"**Required**\",\n    \"0-3\": \"Charge amount.\",\n    \"1-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"2-0\": \"`vaultedShopperId`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"*Create Merchant-Managed Subscription:*\\nOptional; do not include if sending `payerInfo`\",\n    \"2-3\": \"ID of an existing vaulted shopper.\",\n    \"3-0\": \"`payerInfo`\",\n    \"3-1\": \"*object*\",\n    \"3-2\": \"*Create Merchant-Managed Subscription:*\\nOptional; do not include if sending `vaultedShopperId`\",\n    \"3-3\": \"Contains [payerInfo](doc:payer-info) properties.\",\n    \"4-0\": \"`paymentSource`\",\n    \"4-1\": \"*object*\",\n    \"4-2\": \"*Create Merchant-Managed Subscription:*\\n**Required** for `payerInfo`; optional for `vaultedShopperId`\",\n    \"4-3\": \"Contains [paymentSource](doc:payment-source) properties.\",\n    \"5-0\": \"`softDescriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"5-3\": \"Description of the transaction, which appears on the shopper's bank statement. Maximum 20 characters.\",\n    \"6-0\": \"`descriptorPhoneNumber`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"6-3\": \"Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters.\",\n    \"7-0\": \"`authorizedByShopper`\",\n    \"7-1\": \"*boolean*\",\n    \"7-2\": \"*Create Merchant-Managed Subscription:*\\n**Required** for ACH/ECP and SEPA Direct Debit\",\n    \"7-3\": \"Value must be **true**.\\n\\nPass this parameter to indicate that you have obtained the shopper's permission to debit their account.\",\n    \"8-0\": \"`transactionFraudInfo`\",\n    \"8-1\": \"*object*\",\n    \"8-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"8-3\": \"Contains [transactionFraudInfo](doc:transaction-fraud-info) properties.\",\n    \"9-0\": \"`chargeInfo`\",\n    \"9-1\": \"*object*\",\n    \"9-2\": \"*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n    \"9-3\": \"Contains [chargeInfo](doc:charge-info) properties.\",\n    \"10-0\": \"`level3Data`\",\n    \"10-1\": \"*object*\",\n    \"10-2\": \"Optional\",\n    \"10-3\": \"Contains [level3Data](doc:level3data) properties.\",\n    \"11-0\": \"`threeDSecure`\",\n    \"11-1\": \"*object*\",\n    \"11-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"11-3\": \"Contains [threeDSecure](doc:threedsecure) properties.\",\n    \"12-0\": \"`scheduled`\",\n    \"12-1\": \"*boolean*\",\n    \"12-2\": \"*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n    \"12-3\": \"Value can be **true** or **false**.\\n\\nPass this parameter to identify that the transaction is a regularly scheduled event.\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Description\",\n    \"9-0\": \"`paymentSource`\",\n    \"9-1\": \"*object*\",\n    \"9-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"9-2\": \"See [paymentSource](doc:payment-source).\",\n    \"10-0\": \"`chargeInfo`\",\n    \"10-2\": \"See [chargeInfo](doc:charge-info).\",\n    \"10-3\": \"ID of an existing vaulted shopper.\",\n    \"10-1\": \"*object*\",\n    \"1-0\": \"`subscriptionId`\",\n    \"1-3\": \"\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"BlueSnap identifier for the subscription.\",\n    \"4-0\": \"`transactionId`\",\n    \"4-1\": \"*integer*\",\n    \"4-2\": \"BlueSnap identifier for the transaction.\",\n    \"5-0\": \"`transactionDate`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Date (yyyy-mm-dd) of the transaction.\\n\\nFor example: `\\\"2017-07-21\\\"`\",\n    \"6-0\": \"`amount`\",\n    \"6-1\": \"*decimal*\",\n    \"6-2\": \"Charge amount.\",\n    \"7-0\": \"`currency`\",\n    \"7-2\": \"Currency code (ISO 4217) of the charge. See [Currency codes](/docs/currency-codes).\",\n    \"7-1\": \"*string*\",\n    \"8-0\": \"`softDescriptor`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n    \"0-0\": \"`chargeId`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"BlueSnap identifier for the charge.\",\n    \"2-0\": \"`planId`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"BlueSnap identifier for the billing plan.\",\n    \"3-0\": \"`vaultedShopperId`\",\n    \"3-1\": \"*integer*\",\n    \"3-2\": \"ID of the vaulted shopper.\",\n    \"11-0\": \"`processingInfo`\",\n    \"11-1\": \"*object*\",\n    \"11-2\": \"See [processingInfo](doc:processing-info).\",\n    \"13-0\": \"`refunds`\",\n    \"13-1\": \"*object*\",\n    \"13-2\": \"See [refunds](doc:refunds).\",\n    \"12-0\": \"`fraudResultInfo`\",\n    \"12-1\": \"*object*\",\n    \"12-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n    \"14-0\": \"`level3Data`\",\n    \"14-1\": \"*object*\",\n    \"14-2\": \"See [level3Data](doc:level3data).\",\n    \"15-0\": \"`threeDSecure`\",\n    \"15-1\": \"*object*\",\n    \"15-2\": \"See [threeDSecure](doc:threedsecure).\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]","excerpt":"Contains information about a specific recurring subscription charge","slug":"charge","type":"basic","title":"charge"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

charge

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.

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.

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.

refunds

object

See refunds.

level3Data

object

See level3Data.

threeDSecure

object

See threeDSecure.