Create Merchant-Managed Subscription

If you manage your own subscriptions, the Create Merchant-Managed Subscription request enables you to set up a merchant-managed subscription, which associates an initial subscription charge with all recurring charges.

To process recurring subscription charges, you'll send a Create Merchant-Managed Subscription Charge request.

👍

Merchant-Managed Subscriptions guide

For more information on working with merchant-managed subscriptions, refer to Merchant-Managed Subscriptions.


Request Content

charge container    required, contains the following properties (refer to charge):

Property

Type

Required

amount

decimal

required for ACH/ECP and SEPA Direct Debit; optional otherwise

currency

string

required

vendors-info

container

optional (refer to vendors-info)

vaulted-shopper-id

integer

optional - do not include if sending payer-info

payer-info

container

optional - do not include if sending vaulted-shopper-id (refer to payer-info)

payment-source

container

required for payer-info; optional for vaulted-shopper-id (refer to payment-source)

soft-descriptor

string

optional

descriptor-phone-number

string

optional

authorized-by-shopper

boolean

required for ACH/ECP and SEPA Direct Debit, value must be true

three-d-secure

container

optional (refer to three-d-secure)

transaction-fraud-info

container

optional (refer to transaction-fraud-info)

transaction-meta-data

container

optional (refer to transaction-meta-data)

level-3-data

container

optional (refer to level-3-data)

scheduled

boolean

optional

merchant-transaction-id

string

string

tax-reference

string

optional

network-transaction-info

object

optional (refer to network-transaction-info)

transaction-initiator

string

optional

Response Details

If successful, the response HTTP status code is 200 OK. The response body contains the charge resource. The subscription-id appears in the response body (unless payment source was ACH/ECP or SEPA Direct Debit).

Back to Top


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>100</amount>
  <currency>USD</currency>
  <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>
  <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>20.00</meta-value>
      <meta-description>State Tax Amount</meta-description>
    </meta-data>
    <meta-data>
      <meta-key>cityTaxAmount</meta-key>
      <meta-value>20.00</meta-value>
      <meta-description>City Tax Amount</meta-description>
    </meta-data>
    <meta-data>
      <meta-key>shippingAmount</meta-key>
      <meta-value>10.00</meta-value>
      <meta-description>Shipping Amount</meta-description>
    </meta-data>
  </transaction-meta-data>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>45</amount>
  <currency>USD</currency>
  <paymentSource>
    <wallet>
      <walletType>APPLE_PAY</walletType>
      <encodedPaymentToken>eyJiaWxsaW5nQ29udGFjdCI6eyJhZGRyZ...</encodedPaymentToken>
    </wallet>
  </paymentSource>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>45</amount>
  <currency>EUR</currency>
  <authorized-by-shopper>true</authorized-by-shopper>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>12345</zip>
    <country>fr</country>
  </payer-info>
  <payment-source>
    <sepa-direct-debit-info>
      <sepa-direct-debit>
        <iban>DE09100100101234567893</iban>
      </sepa-direct-debit>
    </sepa-direct-debit-info>
  </payment-source>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>65</amount>
  <currency>USD</currency>
  <authorized-by-shopper>true</authorized-by-shopper>
  <payer-info>
    <first-name>Jane</first-name>
    <last-name>Doe</last-name>
    <zip>12345</zip>
    <country>us</country>
  </payer-info>
  <payment-source>
    <ecp-info>
      <ecp>
        <account-number>4099999992</account-number>
        <routing-number>011075150</routing-number>
        <account-type>CONSUMER_CHECKING</account-type>
      </ecp>
    </ecp-info>
  </payment-source>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
   <amount>10</amount>
   <currency>USD</currency>
   <payer-info>
      <address>PIaddress1</address>
      <address2>PIaddress2</address2>
      <city>PICity</city>
      <country>il</country>
      <email>[email protected]</email>
      <first-name>PIFirst-name</first-name>
      <last-name>PILast-name</last-name>
      <zip>PIZip</zip>
   </payer-info>
   <payment-source>
      <credit-card-info>
         <billing-contact-info>
            <address1>BiAddress1</address1>
            <address2>BiAddress2</address2>
            <city>BiCity</city>
            <country>us</country>
            <first-name>BiFirst-name</first-name>
            <last-name>BiLast-name</last-name>
            <state>CA</state>
            <zip>BiZip</zip>
         </billing-contact-info>
         <credit-card>
            <card-number>5555555555554444</card-number>
            <cardType>MASTERCARD</cardType>
            <expiration-month>07</expiration-month>
            <expiration-year>2025</expiration-year>
            <security-code>111</security-code>
         </credit-card>
      </credit-card-info>
   </payment-source>  
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
    <amount>10</amount>
   <currency>USD</currency>
   <payment-source>
      <credit-card-info>
         <billing-contact-info>
            <address1>BiAddress1</address1>
            <address2>BiAddress2</address2>
            <city>BiCity</city>
            <country>us</country>
            <first-name>BiFirst-name</first-name>
            <last-name>BiLast-name</last-name>
            <state>CA</state>
            <zip>BiZip</zip>
         </billing-contact-info>
         <credit-card>
            <card-number>5555555555554444</card-number>
            <cardType>MASTERCARD</cardType>
            <expiration-month>07</expiration-month>
            <expiration-year>2025</expiration-year>
            <security-code>111</security-code>
         </credit-card>
      </credit-card-info>
   </payment-source>
   <vaulted-shopper-id>19641554</vaulted-shopper-id> 
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
     <amount>10</amount>
   <currency>USD</currency>
   <payer-info>
      <address>PIaddress1</address>
      <address2>PIaddress2</address2>
      <city>PICity</city>
      <country>il</country>
      <email>[email protected]</email>
      <first-name>PIFirst-name</first-name>
      <last-name>PILast-name</last-name>
      <zip>PIZip</zip>
   </payer-info>
   <payment-source>
      <credit-card-info>
         <billing-contact-info>
            <address1>BiAddress1</address1>
            <address2>BiAddress2</address2>
            <city>BiCity</city>
            <country>us</country>
            <first-name>BiFirst-name</first-name>
            <last-name>BiLast-name</last-name>
            <state>CA</state>
            <zip>BiZip</zip>
         </billing-contact-info>
         <pf-token>b13f08dc6f2c49c7845520258e8aebfbc0db6d99f1f144cf45e048ada12ff044_</pf-token>
      </credit-card-info>
   </payment-source>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
   <amount>10</amount>
   <currency>USD</currency>
   <payment-source>
      <credit-card-info>
         <billing-contact-info>
            <address1>BiAddress1</address1>
            <address2>BiAddress2</address2>
            <city>BiCity</city>
            <country>us</country>
            <first-name>BiFirst-name</first-name>
            <last-name>BiLast-name</last-name>
            <state>CA</state>
            <zip>BiZip</zip>
         </billing-contact-info>
         <pf-token>c13dca5189e314c4d67069ea5bd18ee076ecf4bb7c824719b5406a797ed2808a_</pf-token>
      </credit-card-info>
   </payment-source>
   <vaulted-shopper-id>19641542</vaulted-shopper-id>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>45</amount>
  <currency>USD</currency>
  <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>
  <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
  <vendors-info>
    <vendor-info>
      <vendor-id>10398032</vendor-id>
    </vendor-info>
  </vendors-info>
</charge>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<charge xmlns="http://ws.plimus.com">
  <amount>100</amount>
  <currency>USD</currency>
  <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>
  <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
  <transaction-meta-data>
    <meta-data>
      <meta-key>stateTaxAmount</meta-key>
      <meta-value>20.00</meta-value>
      <meta-description>State Tax Amount</meta-description>
    </meta-data>
    <meta-data>
      <meta-key>cityTaxAmount</meta-key>
      <meta-value>20.00</meta-value>
      <meta-description>City Tax Amount</meta-description>
    </meta-data>
    <meta-data>
      <meta-key>shippingAmount</meta-key>
      <meta-value>10.00</meta-value>
      <meta-description>Shipping Amount</meta-description>
    </meta-data>
  </transaction-meta-data>
</charge>'

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
  <charge-id>6198862</charge-id>
  <subscription-id>8129231</subscription-id>
  <vaulted-shopper-id>22220051</vaulted-shopper-id>
  <transaction-id>1011791561</transaction-id>
  <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
  <transaction-date>2017-10-12</transaction-date>
  <amount>45.00</amount>
  <currency>USD</currency>
  <soft-descriptor>BLS&#x2a;testing</soft-descriptor>
  <tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
  <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-type>INITIAL</charge-type>
  </charge-info>
  <fraud-result-info>
    <device-data-collector>Y</device-data-collector>
  </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
  <chargeId>175047</chargeId>
  <subscriptionId>39555006</subscriptionId>
  <vaultedShopperId>19598228</vaultedShopperId>
  <transactionId>38599972</transactionId>
  <transactionDate>2021-09-16</transactionDate>
  <amount>45</amount>
  <currency>USD</currency>
  <softDescriptor>BLS*CodeDiggers</softDescriptor>
  <paymentSource>
    <wallet>
      <walletType>APPLE_PAY</walletType>
      <billingContactInfo>
        <firstName>John</firstName>
        <lastName>Smith</lastName>
        <address1>800 South Street</address1>
        <city>Waltham</city>
        <state>MA</state>
        <zip>01822</zip>
        <country>us</country>
      </billingContactInfo>
      <applePay>
        <cardLastFourDigits>1471</cardLastFourDigits>
        <cardType>MASTERCARD</cardType>
        <cardSubType>DEBIT</cardSubType>
        <cardCategory>ACQUIRER ONLY</cardCategory>
        <binCategory>CONSUMER</binCategory>
        <cardRegulated>N</cardRegulated>
        <issuingCountryCode>us</issuingCountryCode>
        <issuingBank>MASTERCARD - MEMBER TEST FACILITY</issuingBank>
        <dpanLastFourDigits>6937</dpanLastFourDigits>
        <dpanExpirationMonth>9</dpanExpirationMonth>
        <dpanExpirationYear>2022</dpanExpirationYear>
      </applePay>
      <tokenizedCard>
        <dpanExpirationMonth>9</dpanExpirationMonth>
        <dpanExpirationYear>2022</dpanExpirationYear>
        <dpanLastFourDigits>6937</dpanLastFourDigits>
        <cardLastFourDigits>1471</cardLastFourDigits>
        <cardType>MASTERCARD</cardType>
        <cardSubType>DEBIT</cardSubType>
        <cardCategory>ACQUIRER ONLY</cardCategory>
        <binCategory>CONSUMER</binCategory>
        <cardRegulated>N</cardRegulated>
        <issuingCountryCode>us</issuingCountryCode>
        <issuingBank>MASTERCARD - MEMBER TEST FACILITY</issuingBank>
      </tokenizedCard>
    </wallet>
  </paymentSource>
  <chargeInfo>
    <chargeType>INITIAL</chargeType>
  </chargeInfo>
  <processingInfo>
    <processingStatus>SUCCESS</processingStatus>
    <authorizationCode>732032</authorizationCode>
  </processingInfo>
  <fraudResultInfo/>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <vaulted-shopper-id>22220063</vaulted-shopper-id>
    <transaction-id>1011791571</transaction-id>
    <transaction-date>2017-10-12</transaction-date>
    <amount>45.00</amount>
    <currency>EUR</currency>
    <soft-descriptor>BLS&#x2a;testing</soft-descriptor>
    <payment-source>
        <sepa-direct-debit-info>
            <sepa-direct-debit>
                <iban-first-four>DE09</iban-first-four>
                <iban-last-four>7893</iban-last-four>
                <mandate-id>Sep165925</mandate-id>
                <mandate-date>12-Oct-17</mandate-date>
                <pre-notification-text>The amount of 45.00 EUR will be collected using SEPA Direct Debit with Mandate Sep165925 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.</pre-notification-text>
                <pre-notification-translation-ref>https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011791571</pre-notification-translation-ref>
            </sepa-direct-debit>
        </sepa-direct-debit-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
  <vaulted-shopper-id>22331737</vaulted-shopper-id>
  <transaction-id>1015615791</transaction-id>
  <transaction-date>2018-01-26</transaction-date>
  <amount>65.00</amount>
  <currency>USD</currency>
  <soft-descriptor>default_descriptor</soft-descriptor>
  <payment-source>
    <ecp-info>
      <ecp>
        <account-number>4099999992</account-number>
        <routing-number>011075150</routing-number>
        <account-type>CONSUMER_CHECKING</account-type>
      </ecp>
    </ecp-info>
  </payment-source>
  <charge-info>
    <charge-type>INITIAL</charge-type>
  </charge-info>
  <processing-info>
    <processing-status>PENDING</processing-status>
  </processing-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <charge-id>251851</charge-id>
    <subscription-id>39600226</subscription-id>
    <vaulted-shopper-id>19643292</vaulted-shopper-id>
    <transaction-id>38599822</transaction-id>
    <transaction-date>2019-03-05</transaction-date>
    <amount>10.00</amount>
    <currency>USD</currency>
    <soft-descriptor>BLS&#x2a;try</soft-descriptor>
    <payment-source>
        <credit-card-info>
            <billing-contact-info>
                <first-name>BiFirst-name</first-name>
                <last-name>BiLast-name</last-name>
                <address1>BiAddress1</address1>
                <address2>BiAddress2</address2>
                <city>BiCity</city>
                <state>CA</state>
                <zip>BiZip</zip>
                <country>us</country>
            </billing-contact-info>
            <credit-card>
                <card-last-four-digits>4444</card-last-four-digits>
                <card-type>MASTERCARD</card-type>
                <bin-category>CONSUMER</bin-category>
                <expiration-month>07</expiration-month>
                <expiration-year>2025</expiration-year>
            </credit-card>
        </credit-card-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
    <fraud-result-info>
        <device-data-collector>N</device-data-collector>
    </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <charge-id>251853</charge-id>
    <subscription-id>39600228</subscription-id>
    <vaulted-shopper-id>19641554</vaulted-shopper-id>
    <transaction-id>38599824</transaction-id>
    <transaction-date>2019-03-05</transaction-date>
    <amount>10.00</amount>
    <currency>USD</currency>
    <soft-descriptor>BLS&#x2a;try</soft-descriptor>
    <payment-source>
        <credit-card-info>
            <billing-contact-info>
                <first-name>BiFirst-name</first-name>
                <last-name>BiLast-name</last-name>
                <address1>BiAddress1</address1>
                <address2>BiAddress2</address2>
                <city>BiCity</city>
                <state>CA</state>
                <zip>BiZip</zip>
                <country>us</country>
            </billing-contact-info>
            <credit-card>
                <card-last-four-digits>4444</card-last-four-digits>
                <card-type>MASTERCARD</card-type>
                <bin-category>CONSUMER</bin-category>
                <expiration-month>07</expiration-month>
                <expiration-year>2025</expiration-year>
            </credit-card>
        </credit-card-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
    <fraud-result-info>
        <device-data-collector>N</device-data-collector>
    </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <charge-id>251855</charge-id>
    <subscription-id>39600230</subscription-id>
    <vaulted-shopper-id>19643294</vaulted-shopper-id>
    <transaction-id>38599826</transaction-id>
    <transaction-date>2019-03-05</transaction-date>
    <amount>10.00</amount>
    <currency>USD</currency>
    <soft-descriptor>BLS&#x2a;try</soft-descriptor>
    <payment-source>
        <credit-card-info>
            <billing-contact-info>
                <first-name>BiFirst-name</first-name>
                <last-name>BiLast-name</last-name>
                <address1>BiAddress1</address1>
                <address2>BiAddress2</address2>
                <city>BiCity</city>
                <state>CA</state>
                <zip>BiZip</zip>
                <country>us</country>
            </billing-contact-info>
            <credit-card>
                <card-last-four-digits>1111</card-last-four-digits>
                <card-type>VISA</card-type>
                <bin-category>CONSUMER</bin-category>
                <expiration-month>11</expiration-month>
                <expiration-year>2023</expiration-year>
            </credit-card>
        </credit-card-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
    <fraud-result-info>
        <device-data-collector>N</device-data-collector>
    </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <charge-id>251857</charge-id>
    <subscription-id>39600232</subscription-id>
    <vaulted-shopper-id>19643294</vaulted-shopper-id>
    <transaction-id>38599828</transaction-id>
    <transaction-date>2019-03-05</transaction-date>
    <amount>10.00</amount>
    <currency>USD</currency>
    <soft-descriptor>BLS&#x2a;try</soft-descriptor>
    <payment-source>
        <credit-card-info>
            <billing-contact-info>
                <first-name>BiFirst-name</first-name>
                <last-name>BiLast-name</last-name>
                <address1>BiAddress1</address1>
                <address2>BiAddress2</address2>
                <city>BiCity</city>
                <state>CA</state>
                <zip>BiZip</zip>
                <country>us</country>
            </billing-contact-info>
            <credit-card>
                <card-last-four-digits>4444</card-last-four-digits>
                <card-type>MASTERCARD</card-type>
                <bin-category>CONSUMER</bin-category>
                <expiration-month>11</expiration-month>
                <expiration-year>2023</expiration-year>
            </credit-card>
        </credit-card-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
    <fraud-result-info>
        <device-data-collector>N</device-data-collector>
    </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
  <charge-id>6198862</charge-id>
  <subscription-id>8129231</subscription-id>
  <vaulted-shopper-id>22220051</vaulted-shopper-id>
  <transaction-id>1011791561</transaction-id>
  <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
  <transaction-date>2017-10-12</transaction-date>
  <amount>45.00</amount>
  <currency>USD</currency>
  <soft-descriptor>BLS&#x2a;testing</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-type>INITIAL</charge-type>
  </charge-info>
  <processing-info>
    <processing-status>PENDING</processing-status>
    <authorization-code>654321</authorization-code>
  </processing-info>
  <fraud-result-info>
    <device-data-collector>Y</device-data-collector>
  </fraud-result-info>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
    <charge-id>18318977</charge-id>
    <subscription-id>19752483</subscription-id>
    <vaulted-shopper-id>27567935</vaulted-shopper-id>
    <transaction-id>1031082453</transaction-id>
    <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
    <transaction-date>2020-05-26</transaction-date>
    <amount>45.00</amount>
    <currency>USD</currency>
    <soft-descriptor>BLS&#x2a;default_descriptor</soft-descriptor>
    <payment-source>
        <credit-card-info>
            <billing-contact-info>
                <first-name>John</first-name>
                <last-name>Doe</last-name>
                <zip>12345</zip>
                <country>us</country>
            </billing-contact-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>
                <bin-category>CONSUMER</bin-category>
                <card-regulated>N</card-regulated>
                <issuing-bank>EXTRAS TEST - VISA</issuing-bank>
                <expiration-month>05</expiration-month>
                <expiration-year>2023</expiration-year>
                <issuing-country-code>ru</issuing-country-code>
            </credit-card>
        </credit-card-info>
    </payment-source>
    <charge-info>
        <charge-type>INITIAL</charge-type>
    </charge-info>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
        <authorization-code>654321</authorization-code>
    </processing-info>
    <vendors-info>
        <vendor-info>
            <vendor-id>10398032</vendor-id>
            <commission-percent>90.2</commission-percent>
        </vendor-info>
    </vendors-info>
    <fraud-result-info/>
</charge>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<charge xmlns="http://ws.plimus.com">
  <charge-id>20400711</charge-id>
  <subscription-id>23453927</subscription-id>
  <vaulted-shopper-id>29970311</vaulted-shopper-id>
  <transaction-id>1039093471</transaction-id>
  <merchant-transaction-id>MyUniqueOnDemandSubscription</merchant-transaction-id>
  <transaction-date>2020-12-28</transaction-date>
  <amount>100.00</amount>
  <currency>USD</currency>
  <soft-descriptor>BLS&#x2a;default_descriptor</soft-descriptor>
  <payment-source>
    <credit-card-info>
      <billing-contact-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <zip>12345</zip>
        <country>us</country>
      </billing-contact-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>
        <bin-category>CONSUMER</bin-category>
        <card-regulated>N</card-regulated>
        <expiration-month>05</expiration-month>
        <expiration-year>2023</expiration-year>
        <issuing-country-code>ru</issuing-country-code>
      </credit-card>
    </credit-card-info>
  </payment-source>
  <charge-info>
    <charge-type>INITIAL</charge-type>
  </charge-info>
  <processing-info>
    <processing-status>SUCCESS</processing-status>
    <authorization-code>654321</authorization-code>
  </processing-info>
  <fraud-result-info />
</charge>

Back to Top


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.

<charge xmlns="http://ws.plimus.com">
  <amount>45</amount>
  <currency>USD</currency>
  <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>
Language
Authentication
Header
Click Try It! to start a request and see the response here!