{"_id":"5b8ec61584303f0003a11518","category":{"_id":"5b8ec61584303f0003a11508","version":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b1973ec0059c20003083ec0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5b8ec61584303f0003a114fc","5b8ec61584303f0003a114fd","5b8ec61584303f0003a114fe","5b8ec61584303f0003a114ff","5b8ec61584303f0003a11500","5b8ec61584303f0003a11501","5b8ec61584303f0003a11502","5b8ec61584303f0003a11503","5b8ec61584303f0003a11504","5b8ec61584303f0003a11505","5b8ec61584303f0003a11506","5b8ec61584303f0003a11507","5b8ec61584303f0003a11508","5b8ec61584303f0003a11509","5b8ec61584303f0003a1150a","5b8ec61584303f0003a1150b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"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":7,"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 ACHP/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\": \"`vaulted-shopper-id`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"*Create Merchant-Managed Subscription:*\\nOptional; do not include if sending `payer-info`\",\n    \"2-3\": \"ID of an existing vaulted shopper.\",\n    \"3-0\": \"`payer-info`\",\n    \"3-1\": \"container\",\n    \"3-2\": \"*Create Merchant-Managed Subscription:*\\nOptional; do not include if sending `vaulted-shopper-id`\",\n    \"3-3\": \"Container of [payer-info](doc:payer-info) properties.\",\n    \"4-0\": \"`payment-source`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"*Create Merchant-Managed Subscription:*\\n**Required** for `payer-info`; optional for `vaulted-shopper-id`\",\n    \"4-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"5-0\": \"`soft-descriptor`\",\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\": \"`descriptor-phone-number`\",\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\": \"`authorized-by-shopper`\",\n    \"7-1\": \"*boolean*\",\n    \"7-2\": \"*Create Merchant-Managed Subscription:*\\n**Required** for 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    \"9-0\": \"`transaction-fraud-info`\",\n    \"9-1\": \"container\",\n    \"9-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"9-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n    \"10-0\": \"`charge-info`\",\n    \"10-1\": \"container\",\n    \"10-2\": \"*Create Merchant-Managed Subscription Charge:*\\nOptional\",\n    \"10-3\": \"Container of [charge-info](doc:charge-info) properties.\",\n    \"11-0\": \"`level-3-data`\",\n    \"11-1\": \"container\",\n    \"11-2\": \"Optional\",\n    \"11-3\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"8-0\": \"`three-d-secure`\",\n    \"8-1\": \"container\",\n    \"8-2\": \"*Create Merchant-Managed Subscription:*\\nOptional\",\n    \"8-3\": \"Container of [three-d-secure](doc:three-d-secure) 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###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Description\",\n    \"9-0\": \"`payment-source`\",\n    \"9-1\": \"container\",\n    \"9-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"9-2\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"10-0\": \"`charge-info`\",\n    \"10-2\": \"Container of [charge-info](doc:charge-info) properties.\",\n    \"10-3\": \"ID of an existing vaulted shopper.\",\n    \"10-1\": \"container\",\n    \"1-0\": \"`subscription-id`\",\n    \"1-3\": \"\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"BlueSnap identifier for the subscription.\",\n    \"4-0\": \"`transaction-id`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"BlueSnap identifier for the transaction.\",\n    \"5-0\": \"`transaction-date`\",\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\": \"`soft-descriptor`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n    \"0-0\": \"`charge-id`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"BlueSnap identifier for the charge.\",\n    \"2-0\": \"`plan-id`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"BlueSnap identifier for the billing plan.\",\n    \"3-0\": \"`vaulted-shopper-id`\",\n    \"3-1\": \"*integer*\",\n    \"3-2\": \"ID of the vaulted shopper.\",\n    \"11-0\": \"`processing-info`\",\n    \"11-1\": \"container\",\n    \"11-2\": \"Container of [processing-info](doc:processing-info) properties.\",\n    \"13-0\": \"`refunds`\",\n    \"13-1\": \"container\",\n    \"13-2\": \"Container of [refunds](doc:refunds) properties.\",\n    \"12-1\": \"container\",\n    \"12-0\": \"`fraud-result-info`\",\n    \"12-2\": \"Container of [fraud-result-info](doc:fraud-result-info) properties.\",\n    \"15-0\": \"`level-3-data`\",\n    \"15-1\": \"container\",\n    \"15-2\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"14-0\": \"`three-d-secure`\",\n    \"14-1\": \"container\",\n    \"14-2\": \"Container of [three-d-secure](doc:three-d-secure) properties.\"\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"}

charge

Contains information about a specific recurring subscription charge

Request

Property Name
Type
Required
Description

amount

decimal

Create Merchant-Managed Subscription:
Required for ACHP/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.

vaulted-shopper-id

integer

Create Merchant-Managed Subscription:
Optional; do not include if sending payer-info

ID of an existing vaulted shopper.

payer-info

container

Create Merchant-Managed Subscription:
Optional; do not include if sending vaulted-shopper-id

Container of payer-info properties.

payment-source

container

Create Merchant-Managed Subscription:
Required for payer-info; optional for vaulted-shopper-id

Container of payment-source properties.

soft-descriptor

string

Create Merchant-Managed Subscription:
Optional

Description of the transaction, which appears on the shopper's bank statement. Maximum 20 characters.

descriptor-phone-number

string

Create Merchant-Managed Subscription:
Optional

Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters.

authorized-by-shopper

boolean

Create Merchant-Managed Subscription:
Required for SEPA Direct Debit

Value must be true.

Pass this parameter to indicate that you have obtained the shopper's permission to debit their account.

three-d-secure

container

Create Merchant-Managed Subscription:
Optional

Container of three-d-secure properties.

transaction-fraud-info

container

Create Merchant-Managed Subscription:
Optional

Container of transaction-fraud-info properties.

charge-info

container

Create Merchant-Managed Subscription Charge:
Optional

Container of charge-info properties.

level-3-data

container

Optional

Container of level-3-data 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
Description

charge-id

integer

BlueSnap identifier for the charge.

subscription-id

integer

BlueSnap identifier for the subscription.

plan-id

integer

BlueSnap identifier for the billing plan.

vaulted-shopper-id

integer

ID of the vaulted shopper.

transaction-id

string

BlueSnap identifier for the transaction.

transaction-date

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.

soft-descriptor

string

Description of the transaction, which appears on the shopper's credit card statement.

payment-source

container

Container of payment-source properties.

charge-info

container

Container of charge-info properties.

processing-info

container

Container of processing-info properties.

fraud-result-info

container

Container of fraud-result-info properties.

refunds

container

Container of refunds properties.

three-d-secure

container

Container of three-d-secure properties.

level-3-data

container

Container of level-3-data properties.