{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"charge","type":"basic","slug":"charge","excerpt":"Contains information about a specific recurring subscription charge","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 \"10-0\": \"`chargeInfo`\",\n \"10-1\": \"*object*\",\n \"10-2\": \"*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n \"10-3\": \"Contains [chargeInfo](doc:charge-info) properties.\",\n \"11-0\": \"`level3Data`\",\n \"11-1\": \"*object*\",\n \"11-2\": \"Optional\",\n \"11-3\": \"Contains [level3Data](doc:level3data) properties.\",\n \"12-0\": \"`threeDSecure`\",\n \"12-1\": \"*object*\",\n \"12-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n \"12-3\": \"Contains [threeDSecure](doc:threedsecure) properties.\",\n \"13-0\": \"`scheduled`\",\n \"13-1\": \"*boolean*\",\n \"13-2\": \"*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n \"13-3\": \"Value can be **true** or **false**.\\n\\nPass this parameter to identify that the transaction is a regularly scheduled event.\",\n \"14-0\": \"`merchantTransactionId`\",\n \"14-1\": \"*string*\",\n \"14-2\": \"Optional\",\n \"14-3\": \"Provides merchant-specific transaction information. 1–50 characters. Special characters are not recommended.\",\n \"15-3\": \"Identifies the order type.<br />The only option is `MOTO` (**M**ail **O**rder **T**elephone **O**rder). <br />Any other option is ignored.\",\n \"15-0\": \"`transactionOrderSource`\",\n \"15-1\": \"*string*\",\n \"15-2\": \"Optional\",\n \"9-0\": \"`transactionMetaData`\",\n \"9-1\": \"*object*\",\n \"9-2\": \"*Create Merchant-Managed Subscription*\\n*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n \"9-3\": \"Contains [transactionMetaData](doc:transaction-meta-data) properties.\"\n },\n \"cols\": 4,\n \"rows\": 16\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 \"14-0\": \"`refunds`\",\n \"14-1\": \"*object*\",\n \"14-2\": \"See [refunds](doc:refunds).\",\n \"12-0\": \"`fraudResultInfo`\",\n \"12-1\": \"*object*\",\n \"12-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n \"15-0\": \"`level3Data`\",\n \"15-1\": \"*object*\",\n \"15-2\": \"See [level3Data](doc:level3data).\",\n \"16-0\": \"`threeDSecure`\",\n \"16-1\": \"*object*\",\n \"16-2\": \"See [threeDSecure](doc:threedsecure).\",\n \"17-2\": \"Merchant-specific transaction information.\",\n \"17-1\": \"*string*\",\n \"17-0\": \"`merchantTransactionId`\",\n \"13-0\": \"`transactionMetaData`\",\n \"13-1\": \"*object*\",\n \"13-2\": \"See [transactionMetaData](doc:transaction-meta-data).\"\n },\n \"cols\": 3,\n \"rows\": 18\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60a40b18fa93ca00237af554","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60a40b18fa93ca00237af4bd","60a40b18fa93ca00237af4be","60a40b18fa93ca00237af4bf","60a40b18fa93ca00237af4c0","60a40b18fa93ca00237af4c1","60a40b18fa93ca00237af4c2","60a40b18fa93ca00237af4c3","60a40b18fa93ca00237af4c4","60a40b18fa93ca00237af4c5","60a40b18fa93ca00237af4c6","60a40b18fa93ca00237af4c7","60a40b18fa93ca00237af4c8","60a40b18fa93ca00237af4c9","60a40b18fa93ca00237af4ca","60a40b18fa93ca00237af4cb","60a40b18fa93ca00237af4cc","60a40b18fa93ca00237af4cd","60a40b18fa93ca00237af4ce","60a40b18fa93ca00237af4cf"],"_id":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603d5bd1309e0703644e931e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":15,"from_sync":false,"reference":false,"_id":"60a40b18fa93ca00237af4c8","version":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-07-18T14:53:58.669Z","__v":0,"parentDoc":null}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.
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.
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.
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.
softDescriptor
string
Description of the transaction, which appears on the shopper's credit card statement.
merchantTransactionId
string
Merchant-specific transaction information.
