If you manage your own subscriptions, the Create Merchant-Managed Subscription Charge request enables you to process recurring charges for a specific subscription. Each charge is associated to the initial subscription based on the subscription ID.
For more information on working with merchant-managed subscriptions, see Merchant-Managed Subscriptions.
Important
The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.
For request and response examples, refer to the Examples section.
Request Content
charge container required, contains the following properties (see charge):
| Property | Type | Required |
|---|---|---|
amount | decimal | required |
charge-info | container | optional (see charge-info) |
currency | string | required |
level-3-data | container | optional (see level-3-data) |
merchant-transaction-id | string | optional |
scheduled | boolean | optional |
tax-reference | string | optional |
transaction-meta-data | container | optional (see transaction-meta-data) |
vendors-info | container | optional (see vendors-info) |
Response Details
If successful, the response HTTP status code is 200 OK.
The response body contains the charge resource.
Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand/10543419 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
<amount>45</amount>
<currency>USD</currency>
<merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
<tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
<transaction-meta-data>
<meta-data>
<meta-key>stateTaxAmount</meta-key>
<meta-value>2</meta-value>
<meta-description>State Tax Amount</meta-description>
</meta-data>
<meta-data>
<meta-key>cityTaxAmount</meta-key>
<meta-value>3</meta-value>
<meta-description>City Tax Amount</meta-description>
</meta-data>
</transaction-meta-data>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand/10543419 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
<amount>45</amount>
<currency>USD</currency>
<scheduled>true</scheduled>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
<zip>12345</zip>
<country>us</country>
</payer-info>
<payment-source>
<credit-card-info>
<credit-card>
<card-number>4012000033330026</card-number>
<security-code>111</security-code>
<expiration-month>05</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
</credit-card-info>
</payment-source>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand/10543419 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
<amount>45</amount>
<currency>USD</currency>
<merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
<vendors-info>
<vendor-info>
<vendor-id>10398032</vendor-id>
</vendor-info>
</vendors-info>
</charge>'
Response Examples
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
<charge-id>6204026</charge-id>
<subscription-id>10543419</subscription-id>
<vaulted-shopper-id>22220051</vaulted-shopper-id>
<transaction-id>1011815941</transaction-id>
<merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
<tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
<transaction-date>2017-10-17</transaction-date>
<amount>45.00</amount>
<currency>USD</currency>
<soft-descriptor>BLS*BlueSnap</soft-descriptor>
<payment-source>
<credit-card-info>
<credit-card>
<card-last-four-digits>0026</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
<expiration-month>05</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
</credit-card-info>
</payment-source>
<charge-info>
<charge-description>OnDemand Subscription Charge</charge-description>
<charge-type>RECURRING</charge-type>
</charge-info>
<processing-info>
<processing-status>SUCCESS</processing-status>
<transaction-region>US</transaction-region>
</processing-info>
</charge>
API Explorer
To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.