The Create Subscription request enables you to set up a subscription, which associates a shopper with a plan to bill on an ongoing basis.

For more information about working with subscriptions, see the Subscriptions tutorial.

📘
Apple Pay and Subscriptions
Our acquirer in Israel does not support ApplePay subscriptions except for American Express cards. As a result, we are blocking the creation of subscriptions using ApplePay for all non-American Express cards. We will return an error message if you attempt to create an ApplePay subscription using a non-American Express card.

👍
Testing subscription charges in sandbox
After creating a subscription in sandbox, you can simulate a recurring charge event and trigger associated IPNs, emails, and invoices. Refer to the Subscriptions Guide to learn how.

Request Content

Send a subscription object, with the following:

Property	Type	Required
`authorizedByShopper`	boolean	required for ACH/ECP and SEPA Direct Debit value must be true
`descriptorPhoneNumber`	string	optional
`initialTaxReference`	string	optional
`level3Data`	object	optional (refer to level3Data)
`networkTransactionInfo`	object	optional (refer to networkTransactionInfo)
`overrideInitialChargeAmount`	decimal	optional
`overrideRecurringChargeAmount`	decimal	optional
`overrideTrialPeriodDays`	integer	optional
`payerInfo`	object	optional - do not include if sending `vaultedShopperId` (refer to payerInfo)
`paymentSource`	object	required for `payerInfo`; optional for `vaultedShopperId` (refer to paymentSource)
`planId`	integer	required
`quantity`	integer	optional
`recurringTaxReference`	string	optional
`shippingContactInfo`	object	optional (refer to shippingContactInfo)
`softDescriptor`	string	optional
`threeDSecure`	object	optional (refer to threeDSecure)
`transactionFraudInfo`	object	optional (refer to transactionFraudInfo)
`transactionInitiator`	string	optional
`vaultedShopperId`	integer	optional - do not include if sending `payerInfo`
`vendorsInfo`	object	optional (refer to vendorsInfo)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the subscription object.
The subscriptionId appears in the response body and the location header (unless ACH or SEPA DD was used).

Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "payerInfo": {
        "zip": 02453,
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
    "paymentSource": {"creditCardInfo": {"creditCard": {
        "expirationYear": 2023,
        "securityCode": 111,
        "expirationMonth": "07",
        "cardNumber": 4111111111111111
    }}},
    "planId": 2283845,
    "transactionFraudInfo": {
        "fraudSessionId": 1234,
        "customerId": "121341",
        "customerCreationDate": "2021-08-05"
    }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "vaultedShopperId": 20769005,
    "overrideInitialChargeAmount": 10.5,
    "overrideRecurringChargeAmount": 29.99,
    "quantity": 2,
    "overrideTrialPeriodDays": 10,
    "softDescriptor": "Merchant name",
    "planId": 2283845,
    "transactionFraudInfo": {
        "shopperIpAddress": "123.12.134.1",
        "fraudSessionId": 1234,
        "company": "Company Name",
        "shippingContactInfo": {
            "zip": 02453,
            "country": "US",
            "firstName": "Doe",
            "lastName": "John",
            "city": "Juneau",
            "address2": "Apt 2",
            "address1": "1 Main St",
            "state": "AK"
        }
    }
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "vaultedShopperId": 20769005,
    "paymentSource": {"creditCardInfo": {"creditCard": {
        "cardLastFourDigits": "9299",
        "cardType": "VISA"
    }}},
    "planId": 2283845
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{  
   "payerInfo":{  
      "zip":02453,
      "firstName":"John",
      "lastName":"Doe",
      "phone":1234567890
   },
   "paymentSource":{  
       "pfToken":"339110a75e2cdbb5f5f2cea8d7cd8af261ad7c89fb0ce1aae_"
   },
   "planId":2186278
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "payerInfo": {
    "zip": 02453,
    "firstName": "John",
    "lastName": "Doe",
    "phone": 1234567890
  },
  "paymentSource": {
    "creditCardInfo": {
      "creditCard": {
        "expirationYear": 2023,
        "securityCode": 111,
        "expirationMonth": "07",
        "cardNumber": 4111111111111111
      }
    }
  },
  "planId": 2283845,
  "transactionFraudInfo": {
    "fraudSessionId": 1234
  },
  "vendorsInfo": {
    "vendorInfo": [{ "vendorId": "10398032" }]
  }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
	"planId": 2193990,
	"paymentSource": {
		"wallet": {
			"walletType": "APPLE_PAY",
			"encodedPaymentToken": "eyJiaWxsaW5nQ29udGFjdCI6eyJhZGRyZ..."
		}
	}
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "planId": 2283845,
    "authorizedByShopper": true,
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "country": "fr",
        "zip": "75001",
        "phone": "1234567890"
    },
    "paymentSource": {
        "sepaDirectDebitInfo": {
            "sepaDirectDebit": {
                "iban": "DE09100100101234567893"
            }
        }
    }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "planId": 2380391,
    "authorizedByShopper": true,
    "payerInfo": {
        "firstName": "Jane",
        "lastName": "Doe",
        "country": "us",
        "zip": "02453",
        "phone": "1234567890"
    },
    "paymentSource": {
      "ecpInfo": {
        "ecp": {
          "accountNumber": 4099999992, 
          "routingNumber": "011075150",
          "accountType": "CONSUMER_CHECKING"
        }
      }
   }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "paymentSource": {
        "wallet": {
           "walletType": "GOOGLE_PAY",
           "encodedPaymentToken": "eyJwYXltZW50TWV0aG9kVG9rZW4iOnsilIjoiIn19"
     }},
    "planId": 2283845,
    "transactionFraudInfo": {"fraudSessionId": 1234}
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{  
   "payerInfo":{  
      "firstName":"PIFirstName",
      "lastName":"PILastName",
      "zip":"PIZip",
      "email":"[email protected]",
      "country":"il",
      "address":"PIaddress1",
      "address2":"PIaddress2",
      "city":"PICity"
   },
   "paymentSource":{  
      "creditCardInfo":{  
         "creditCard":{  
            "cardNumber":"5555555555554444",
            "securityCode":"111",
            "cardType":"MASTERCARD",
            "expirationMonth":"07",
            "expirationYear":"2025"
         },
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "country":"us",
            "zip":"BiZip"
         }
      }
   },
   "planId":2205010
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{  
   "vaultedShopperId":19641522,
   "paymentSource":{  
      "creditCardInfo":{  
         "creditCard":{  
            "cardNumber":"5555555555554444",
            "securityCode":"111",
            "cardType":"MASTERCARD",
            "expirationMonth":"07",
            "expirationYear":"2025"
         },
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "country":"us",
            "zip":"BiZip"
         }
      }
   },
   "planId":2205010
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "payerInfo": {
        "firstName": "PIFirstName",
        "lastName": "PILastName",
        "zip": "PIZip",
        "email": "[email protected]",
        "country": "il",
        "address": "PIaddress1",
        "address2": "PIaddress2",
        "city": "PICity"
    },
    "paymentSource": {
        "creditCardInfo": {
            "pfToken": "2586d05c0479ba1936db771124f74727a418ea5f0841054217fedfc403a76ad0_",
            "billingContactInfo": {
                "firstName": "BiFirstName",
                "lastName": "BiLastName",
                "address1": "BiAddress1",
                "address2": "BiAddress2",
                "city": "BiCity",
                "state": "CA",
                "country": "us",
                "zip": "BiZip"
            }
        }
    },
    "planId": 2205010
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{  
   "vaultedShopperId":19641506,
   "paymentSource":{  
      "creditCardInfo":{  
         "pfToken":"5df3b5db58d174315efde493b12afff24e33d3709490a4e99b28046497d95f7f_",
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "country":"us",
            "zip":"BiZip"
         }
      }
   },
   "planId":2205010
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "planId": 2190390,
    "vaultedShopperId": 19574268,
    "paymentSource": {
    "creditCardInfo": {
    		"creditCard": {
        		"cardLastFourDigits": "1111",
        		"cardType": "VISA"
    		}
    	}
    },
    "threeDSecure": {
  		"threeDSecureReferenceId":"4851"
  }
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "payerInfo": {
    "zip": 12345,
    "firstName": "John",
    "lastName": "Doe",
    "phone": 12345678909876
  },
  "paymentSource": {
    "creditCardInfo": {
      "creditCard": {
        "expirationYear": 2025,
        "securityCode": 111,
        "expirationMonth": 10,
        "cardNumber": "4111 1111 1111 1111"
      }
    }
  },
  "planId": 1234567,
  "vendorsInfo": {
    "vendorInfo": [
      {
        "vendorId": 7654321,
        "commissionAmount": 10,
        "recurringCommissionPercent": 50
      },
      {
        "vendorId": 7654322,
        "commissionPercent": 5,
        "recurringCommissionAmount": 3
      }
    ]
  }
}'

Response Examples

{
    "nextChargeDate": "2016-08-16",
    "quantity": 1,
    "charge": {
        "amount": 100,
        "vaultedShopperId": 21188909,
        "chargeInfo": {
          "fromDate": "2016-08-02",
          "toDate": "2016-08-16",
          "chargeType": "INITIAL"
        },
      "processingInfo": {
          "processingStatus": "success",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
      },
        "chargeId": 12117877,
        "paymentSource": {"creditCardInfo": {"creditCard": {
            "expirationYear": 2023,
            "cardLastFourDigits": 1111,
            "cardSubType": "CREDIT",
            "cardType": "VISA",
            "expirationMonth": "07"
        }}},
        "softDescriptor": "BLS&#x2a;default_descriptor",
        "planId": 2283845,
        "currency": "USD",
        "transactionDate": "2016-08-02",
        "subscriptionId": 8492717,
        "transactionId": 1012463333
    },
    "trialPeriodDays": 14,
    "paymentSource": {"creditCardInfo": {
        "billingContactInfo": {
            "firstName": "John",
            "lastName": "Doe"
        },
        "creditCard": {
            "expirationYear": 2019,
            "cardLastFourDigits": 1111,
            "cardSubType": "CREDIT",
          	"cardCategory": "CLASSIC",
            "cardType": "VISA",
            "expirationMonth": "07"
        }
    }},
    "softDescriptor": "BLS&#x2a;default_descriptor",
    "recurringChargeAmount": 29.99,
    "chargeFrequency": "MONTHLY",
    "vaultedShopperId": 21188909,
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe"
    },
    "initialChargeAmount": 100,
    "autoRenew": true,
    "planId": 2283845,
    "currency": "USD",
    "subscriptionId": 8492717,
    "fraudResultInfo": {"deviceDataCollector": "Y"},
    "status": "ACTIVE",
}

{
    "subscriptionId": 39555010,
    "planId": 2193990,
    "vaultedShopperId": 19598232,
    "status": "ACTIVE",
    "quantity": 1,
    "softDescriptor": "BLS*CodeDiggers",
    "chargeFrequency": "WEEKLY",
    "recurringChargeAmount": 4.20,
    "currency": "USD",
    "autoRenew": true,
    "nextChargeDate": "2021-09-23",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "[email protected]",
        "country": "us",
        "state": "MA",
        "address": "800 South Street",
        "city": "Waltham",
        "zip": "01822"
    },
    "paymentSource": {
        "wallet": {
            "walletType": "APPLE_PAY",
            "billingContactInfo": {
                "firstName": "John",
                "lastName": "Smith",
                "address1": "800 South Street",
                "city": "Waltham",
                "state": "MA",
                "zip": "01822",
                "country": "us"
            },
            "applePay": {
                "cardLastFourDigits": "1471",
                "cardType": "MASTERCARD",
                "cardSubType": "DEBIT",
                "cardCategory": "ACQUIRER ONLY",
                "binCategory": "CONSUMER",
                "cardRegulated": "N",
                "issuingCountryCode": "us",
                "issuingBank": "MASTERCARD - MEMBER TEST FACILITY",
                "dpanLastFourDigits": "6937",
                "dpanExpirationMonth": "9",
                "dpanExpirationYear": "2022"
            },
            "tokenizedCard": {
                "dpanExpirationMonth": "9",
                "dpanExpirationYear": "2022",
                "dpanLastFourDigits": "6937",
                "cardLastFourDigits": "1471",
                "cardType": "MASTERCARD",
                "cardSubType": "DEBIT",
                "cardCategory": "ACQUIRER ONLY",
                "binCategory": "CONSUMER",
                "cardRegulated": "N",
                "issuingCountryCode": "us",
                "issuingBank": "MASTERCARD - MEMBER TEST FACILITY"
            }
        }
    },
    "charge": {
        "chargeId": 175051,
        "subscriptionId": 39555010,
        "planId": 2193990,
        "vaultedShopperId": 19598232,
        "transactionId": "38599976",
        "transactionDate": "2021-09-16",
        "amount": 4.20,
        "currency": "USD",
        "softDescriptor": "BLS*CodeDiggers",
        "paymentSource": {
            "wallet": {
                "walletType": "APPLE_PAY",
                "billingContactInfo": {
                    "firstName": "John",
                    "lastName": "Smith",
                    "address1": "800 South Street",
                    "city": "Waltham",
                    "state": "MA",
                    "zip": "01822",
                    "country": "us"
                },
                "applePay": {
                    "cardLastFourDigits": "1471",
                    "cardType": "MASTERCARD",
                    "cardSubType": "DEBIT",
                    "cardCategory": "ACQUIRER ONLY",
                    "binCategory": "CONSUMER",
                    "cardRegulated": "N",
                    "issuingCountryCode": "us",
                    "issuingBank": "MASTERCARD - MEMBER TEST FACILITY",
                    "dpanLastFourDigits": "6937",
                    "dpanExpirationMonth": "9",
                    "dpanExpirationYear": "2022"
                },
                "tokenizedCard": {
                    "dpanExpirationMonth": "9",
                    "dpanExpirationYear": "2022",
                    "dpanLastFourDigits": "6937",
                    "cardLastFourDigits": "1471",
                    "cardType": "MASTERCARD",
                    "cardSubType": "DEBIT",
                    "cardCategory": "ACQUIRER ONLY",
                    "binCategory": "CONSUMER",
                    "cardRegulated": "N",
                    "issuingCountryCode": "us",
                    "issuingBank": "MASTERCARD - MEMBER TEST FACILITY"
                }
            }
        },
        "chargeInfo": {
            "fromDate": "2021-09-16",
            "toDate": "2021-09-23",
            "chargeType": "INITIAL"
        },
        "processingInfo": {
          "processingStatus": "SUCCESS",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
        }
    },
    "fraudResultInfo": {}
}

{
  "planId": 2436197,
  "vaultedShopperId": 21804015,
  "softDescriptor": "Oooops LTD",
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "country": "fr",
    "zip": "75001",
    "phone": "1234567890"
  },
  "paymentSource": {
    "sepaDirectDebitInfo": {
      "sepaDirectDebit": {
        "ibanFirstFour": "DE09",
        "ibanLastFour": "7893",
        "mandateId": "Ooo154091",
        "mandateDate": "25-Jul-17",
        "preNotificationText": "The amount of 29.99 EUR will be collected using SEPA Direct Debit with Mandate Ooo154091 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account."
      }
    }
  },
  "charge": {
    "planId": 2436197,
    "vaultedShopperId": 21804015,
    "transactionId": "1011216623",
    "transactionDate": "2017-07-25",
    "amount": 29.99,
    "currency": "EUR",
    "softDescriptor": "Oooops LTD",
    "paymentSource": {
      "sepaDirectDebitInfo": {
        "sepaDirectDebit": {
          "ibanFirstFour": "DE09",
          "ibanLastFour": "7893",
          "mandateId": "Ooo154091",
          "mandateDate": "25-Jul-17",
          "preNotificationText": "The amount of 29.99 EUR will be collected using SEPA Direct Debit with Mandate Ooo154091 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account."
        }
      }
    },
    "processingInfo": {
          "processingStatus": "PENDING",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
    }
  }
}

{
  "planId": 2380391,
  "vaultedShopperId": 22330617,
  "softDescriptor": "default_descriptor",
  "payerInfo": {
    "firstName": "Jane",
    "lastName": "Doe",
    "country": "us",
    "zip": "02453",
    "phone": "1234567890"
  },
  "paymentSource": {
    "ecpInfo": {
      "ecp": {
        "accountNumber": "4099999992",
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING"
      }
    }
  },
  "charge": {
    "planId": 2380391,
    "vaultedShopperId": 22330617,
    "transactionId": "1015610101",
    "transactionDate": "2018-01-25",
    "amount": 65,
    "currency": "USD",
    "softDescriptor": "default_descriptor",
    "paymentSource": {
      "ecpInfo": {
        "ecp": {
          "accountNumber": "4099999992",
          "routingNumber": "011075150",
          "accountType": "CONSUMER_CHECKING"
        }
      }
    },
    "chargeInfo": {
      "chargeType": "INITIAL"
    },
    "processingInfo": {
          "processingStatus": "PENDING",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
    }
  }
}

{
    "subscriptionId": 39594120,
    "planId": 2203980,
    "vaultedShopperId": 19637272,
    "status": "ACTIVE",
    "quantity": 1,
    "softDescriptor": "BLS",
    "chargeFrequency": "MONTHLY",
    "recurringChargeAmount": 1.99,
    "currency": "USD",
    "autoRenew": true,
    "nextChargeDate": "2018-10-05",
    "payerInfo": {
        "firstName": "test first name",
        "lastName": "test last name", 
      	"zip": "02453",
        "country": "us",
        "state": "MA",
        "email": "test&#x40;gmail.com",
        "address": "32 some street",
        "city": "some city",
        "zip": "02186",
        "phone": "456276576"
    },
    "paymentSource": {
        "creditCardInfo": {
            "billingContactInfo": {
                "firstName": "test first name",
                "lastName": "test last name", 
      	        "zip": "02453",
                "country": "us",
                "state": "MA",
                "address": "32 some street",
                "city": "some city",
                "zip": "02186"
            },
            "creditCard": {
                "cardLastFourDigits": "1111",
                "cardType": "VISA",
                "cardSubType": "CREDIT",
                "cardCategory": "CLASSIC",
                "expirationMonth": "09",
                "expirationYear": "2022"
            }
        }
    },
    "charge": {
        "chargeId": 250389,
        "subscriptionId": 39594120,
        "planId": 2203980,
        "vaultedShopperId": 19637272,
        "transactionId": "38589782",
        "transactionDate": "2018-09-05",
        "amount": 1.99,
        "currency": "USD",
        "softDescriptor": "BLS",
        "paymentSource": {
            "creditCardInfo": {
                "creditCard": {
                    "cardLastFourDigits": "1111",
                    "cardType": "VISA",
                    "cardSubType": "CREDIT",
                    "cardCategory": "CLASSIC",
                    "expirationMonth": "09",
                    "expirationYear": "2022"
                }
            }
        },
        "chargeInfo": {
            "fromDate": "2018-09-05",
            "toDate": "2018-10-05",
            "chargeType": "INITIAL"
        },
        "processingInfo": {
          "processingStatus": "SUCCESS",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
        }
    },
    "fraudResultInfo": {
        "deviceDataCollector": "N"
    }
}

{
    "cardTransactionType": "AUTH_ONLY",
    "transactionId": "1012751937",
    "softDescriptor": "BLS&#x2a;DescTest",
    "amount": 11,
    "currency": "USD",
    "cardHolderInfo": {
        "firstName": "test first name",
        "lastName": "test last name", 
      	"zip": "02453",
        "country": "us"
    },
    "vaultedShopperId": 21289371,
    "wallet": {
        "walletType": "GOOGLE_PAY",
        "billingContactInfo": {
            "firstName": "test first name",
            "lastName": "test last name",
            "zip": "02453",
            "country": "us"
        },
        "tokenizedCard": {
            "cardLastFourDigits": "1111",
            "cardType": "VISA",
            "cardSubType": "CREDIT",
            "dpanExpirationMonth": "9",
            "dpanExpirationYear": "2025",
            "dpanLastFourDigits": "2222"
        }
    },
    "processingInfo": {
          "processingStatus": "SUCCESS",
          "cvvResponseCode": "MA",
          "authorizationCode": "OK1510",
          "avsResponseCodeZip": "U",
          "avsResponseCodeAddress": "U",
          "avsResponseCodeName": "U",
          "networkTransactionId": 16029749259621,
          "transactionRegion": "US"
    }
}

{  
   "payerInfo":{  
      "firstName":"PIFirstName",
      "lastName":"PILastName",
      "zip":"PIZip",
      "email":"[email protected]",
      "country":"il",
      "address":"PIaddress1",
      "address2":"PIaddress2",
      "city":"PICity"
   },
   "paymentSource":{  
      "creditCardInfo":{  
         "creditCard":{  
            "cardNumber":"5555555555554444",
            "securityCode":"111",
            "cardType":"MASTERCARD",
            "expirationMonth":"07",
            "expirationYear":"2025"
         },
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "country":"us",
            "zip":"BiZip"
         }
      }
   },
   "planId":2205010
}

{  
   "subscriptionId":39598752,
   "planId":2205010,
   "vaultedShopperId":19641738,
   "status":"ACTIVE",
   "quantity":1,
   "softDescriptor":"BLS*try",
   "chargeFrequency":"MONTHLY",
   "recurringChargeAmount":1.99,
   "currency":"USD",
   "autoRenew":true,
   "nextChargeDate":"2019-02-27",
   "payerInfo":{  
      "firstName":"Shevie",
      "lastName":"Chen",
      "country":"us"
   },
   "paymentSource":{  
      "creditCardInfo":{  
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "zip":"BiZip",
            "country":"us"
         },
         "creditCard":{  
            "cardLastFourDigits":"4444",
            "cardType":"MASTERCARD",
            "binCategory":"CONSUMER",
            "cardRegulated":"N",
            "expirationMonth":"07",
            "expirationYear":"2025",
            "issuingCountryCode":"BR"
         }
      }
   },
   "charge":{  
      "chargeId":251237,
      "subscriptionId":39598752,
      "planId":2205010,
      "vaultedShopperId":19641738,
      "transactionId":"38597238",
      "transactionDate":"2019-01-27",
      "amount":1.99,
      "currency":"USD",
      "softDescriptor":"BLS*try",
      "paymentSource":{  
         "creditCardInfo":{  
            "billingContactInfo":{  
               "firstName":"BiFirstName",
               "lastName":"BiLastName",
               "address1":"BiAddress1",
               "address2":"BiAddress2",
               "city":"BiCity",
               "state":"CA",
               "zip":"BiZip",
               "country":"us"
            },
            "creditCard":{  
               "cardLastFourDigits":"4444",
               "cardType":"MASTERCARD",
               "binCategory":"CONSUMER",
               "expirationMonth":"07",
               "expirationYear":"2025"
            }
         }
      },
      "chargeInfo":{  
         "fromDate":"2019-01-27",
         "toDate":"2019-02-27",
         "chargeType":"INITIAL"
      },
      "processingInfo":{
         "processingStatus": "SUCCESS",
         "cvvResponseCode": "MA",
         "authorizationCode": "OK1510",
         "avsResponseCodeZip": "U",
         "avsResponseCodeAddress": "U",
         "avsResponseCodeName": "U",
         "networkTransactionId": 16029749259621,
         "transactionRegion": "US"
      }
   },
   "fraudResultInfo":{  
      "deviceDataCollector":"N"
   }
}

{ 
   "subscriptionId":39598758,
   "planId":2205010,
   "vaultedShopperId":19641744,
   "status":"ACTIVE",
   "quantity":1,
   "softDescriptor":"BLS*try",
   "chargeFrequency":"MONTHLY",
   "recurringChargeAmount":1.99,
   "currency":"USD",
   "autoRenew":true,
   "nextChargeDate":"2019-02-27",
   "payerInfo":{  
      "firstName":"PIFirstName",
      "lastName":"PILastName",
      "email":"[email protected]",
      "country":"il",
      "address":"PIaddress1",
      "address2":"PIaddress2",
      "city":"PICity",
      "zip":"PIZip"
   },
   "paymentSource":{  
      "creditCardInfo":{  
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "zip":"BiZip",
            "country":"us"
         },
         "creditCard":{  
            "cardLastFourDigits":"0005",
            "cardType":"AMEX",
            "cardCategory":"CORPORATE",
            "binCategory":"COMMERCIAL",
            "cardRegulated":"Y",
            "issuingBank":"AMERICAN EXPRESS US (CARS)",
            "expirationMonth":"11",
            "expirationYear":"2024",
            "issuingCountryCode":"US"
         }
      }
   },
   "charge":{  
      "chargeId":251243,
      "subscriptionId":39598758,
      "planId":2205010,
      "vaultedShopperId":19641744,
      "transactionId":"38597248",
      "transactionDate":"2019-01-27",
      "amount":1.99,
      "currency":"USD",
      "softDescriptor":"BLS*try",
      "paymentSource":{  
         "creditCardInfo":{  
            "billingContactInfo":{  
               "firstName":"BiFirstName",
               "lastName":"BiLastName",
               "address1":"BiAddress1",
               "address2":"BiAddress2",
               "city":"BiCity",
               "state":"CA",
               "zip":"BiZip",
               "country":"us"
            },
            "creditCard":{  
               "cardLastFourDigits":"0005",
               "cardType":"AMEX",
               "binCategory":"CONSUMER",
               "expirationMonth":"11",
               "expirationYear":"2024"
            }
         }
      },
      "chargeInfo":{  
         "fromDate":"2019-01-27",
         "toDate":"2019-02-27",
         "chargeType":"INITIAL"
      },
      "processingInfo":{
         "processingStatus": "SUCCESS",
         "cvvResponseCode": "MA",
         "authorizationCode": "OK1510",
         "avsResponseCodeZip": "U",
         "avsResponseCodeAddress": "U",
         "avsResponseCodeName": "U",
         "networkTransactionId": 16029749259621,
         "transactionRegion": "US"
      }
   },
   "fraudResultInfo":{  
      "deviceDataCollector":"N"
   }
}

{ 
   "subscriptionId":39598738,
   "planId":2205010,
   "vaultedShopperId":19641724,
   "status":"ACTIVE",
   "quantity":1,
   "softDescriptor":"BLS*try",
   "chargeFrequency":"MONTHLY",
   "recurringChargeAmount":1.99,
   "currency":"USD",
   "autoRenew":true,
   "nextChargeDate":"2019-02-27",
   "payerInfo":{  
      "firstName":"Shevie",
      "lastName":"Chen",
      "country":"us"
   },
   "paymentSource":{  
      "creditCardInfo":{  
         "billingContactInfo":{  
            "firstName":"BiFirstName",
            "lastName":"BiLastName",
            "address1":"BiAddress1",
            "address2":"BiAddress2",
            "city":"BiCity",
            "state":"CA",
            "zip":"BiZip",
            "country":"us"
         },
         "creditCard":{  
            "cardLastFourDigits":"0005",
            "cardType":"AMEX",
            "cardCategory":"CORPORATE",
            "binCategory":"COMMERCIAL",
            "cardRegulated":"Y",
            "issuingBank":"AMERICAN EXPRESS US (CARS)",
            "expirationMonth":"11",
            "expirationYear":"2024",
            "issuingCountryCode":"US"
         }
      }
   },
   "charge":{  
      "chargeId":251223,
      "subscriptionId":39598738,
      "planId":2205010,
      "vaultedShopperId":19641724,
      "transactionId":"38597218",
      "transactionDate":"2019-01-27",
      "amount":1.99,
      "currency":"USD",
      "softDescriptor":"BLS*try",
      "paymentSource":{  
         "creditCardInfo":{  
            "billingContactInfo":{  
               "firstName":"BiFirstName",
               "lastName":"BiLastName",
               "address1":"BiAddress1",
               "address2":"BiAddress2",
               "city":"BiCity",
               "state":"CA",
               "zip":"BiZip",
               "country":"us"
            },
            "creditCard":{  
               "cardLastFourDigits":"0005",
               "cardType":"AMEX",
               "binCategory":"CONSUMER",
               "expirationMonth":"11",
               "expirationYear":"2024"
            }
         }
      },
      "chargeInfo":{  
         "fromDate":"2019-01-27",
         "toDate":"2019-02-27",
         "chargeType":"INITIAL"
      },
      "processingInfo":{
         "processingStatus": "SUCCESS",
         "cvvResponseCode": "MA",
         "authorizationCode": "OK1510",
         "avsResponseCodeZip": "U",
         "avsResponseCodeAddress": "U",
         "avsResponseCodeName": "U",
         "networkTransactionId": 16029749259621,
         "transactionRegion": "US"
      }
   },
   "fraudResultInfo":{  
      "deviceDataCollector":"N"
   }
}

{
    "planId": 2190390,
    "vaultedShopperId": 19574268,
    "softDescriptor": "BLS*BS",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "country": "us",
        "state": "CA",
        "address": "138 Market St",
        "city": "San Francisco",
        "zip": "75654",
        "phone": "14135556789"
    },
    "paymentSource": {
        "creditCardInfo": {
            "billingContactInfo": {
                "firstName": "John",
                "lastName": "Doe",
                "address1": "138 Market St",
                "city": "San Francisco",
                "state": "CA",
                "zip": "75654",
                "country": "us"
            },
            "creditCard": {
                "cardLastFourDigits": "1111",
                "cardType": "VISA",
                "cardSubType": "CREDIT",
                "binCategory": "CONSUMER",
                "issuingBank": "JPMORGAN CHASE BANK, N.A.",
                "expirationMonth": "09",
                "expirationYear": "2023",
                "issuingCountryCode": "us"
            }
        }
    },
    "charge": {
        "planId": 2190390,
        "vaultedShopperId": 19574268,
        "transactionId": "38510944",
        "transactionDate": "2019-07-24",
        "amount": 10.00,
        "currency": "USD",
        "softDescriptor": "BLS*BS",
        "paymentSource": {
            "creditCardInfo": {
                "billingContactInfo": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "address1": "138 Market St",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": "75654",
                    "country": "us"
                },
                "creditCard": {
                    "cardLastFourDigits": "1111",
                    "cardType": "VISA",
                    "cardSubType": "CREDIT",
                    "binCategory": "CONSUMER",
                    "issuingBank": "JPMORGAN CHASE BANK, N.A.",
                    "expirationMonth": "09",
                    "expirationYear": "2019",
                    "issuingCountryCode": "us"
                }
            }
        },
        "chargeInfo": {
            "chargeType": "INITIAL"
        },
        "processingInfo": {
            "processingStatus": "SUCCESS",
            "cvvResponseCode": "MA",
            "authorizationCode": "OK1510",
            "avsResponseCodeZip": "U",
            "avsResponseCodeAddress": "U",
            "avsResponseCodeName": "U",
            "networkTransactionId": 16029749259621,
            "transactionRegion": "US"
        }
    },
    "fraudResultInfo": {
        "deviceDataCollector": "N"
    },
    "threeDSecure": {
        "authenticationResult": "AUTHENTICATION_SUCCEEDED"
    }
}

{
    "nextChargeDate": "2016-08-16",
    "quantity": 1,
    "charge": {
        "amount": 100,
        "vaultedShopperId": 21188909,
        "chargeInfo": {
            "fromDate": "2016-08-02",
            "toDate": "2016-08-16",
            "chargeType": "INITIAL"
        },
        "chargeId": 12117877,
        "paymentSource": {"creditCardInfo": {"creditCard": {
            "expirationYear": 2023,
            "cardLastFourDigits": 1111,
            "cardSubType": "CREDIT",
            "cardType": "VISA",
            "expirationMonth": "07"
        }}},
        "softDescriptor": "BLS&#x2a;default_descriptor",
        "planId": 2283845,
        "currency": "USD",
        "transactionDate": "2016-08-02",
        "subscriptionId": 8492717,
        "transactionId": 1012463333
    },
    "trialPeriodDays": 14,
    "paymentSource": {"creditCardInfo": {
        "billingContactInfo": {
            "firstName": "John",
            "lastName": "Doe"
        },
        "creditCard": {
            "expirationYear": 2019,
            "cardLastFourDigits": 1111,
            "cardSubType": "CREDIT",
          	"cardCategory": "CLASSIC",
            "cardType": "VISA",
            "expirationMonth": "07"
        }
    }},
    "softDescriptor": "BLS&#x2a;default_descriptor",
    "recurringChargeAmount": 29.99,
    "chargeFrequency": "MONTHLY",
    "vaultedShopperId": 21188909,
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe"
    },
    "initialChargeAmount": 100,
    "autoRenew": true,
    "planId": 2283845,
    "currency": "USD",
    "subscriptionId": 8492717,
    "processingInfo": {
      "processingStatus": "SUCCESS",
      "cvvResponseCode": "MA",
      "authorizationCode": "OK1510",
      "avsResponseCodeZip": "U",
      "avsResponseCodeAddress": "U",
      "avsResponseCodeName": "U",
      "networkTransactionId": 16029749259621,
      "transactionRegion": "US"
    },
    "fraudResultInfo": {"deviceDataCollector": "Y"},
    "status": "ACTIVE"
}

{
  "subscriptionId": 19752551,  
  "planId": 2283845,
  "vaultedShopperId": 27567993,
  "status": "ACTIVE",
  "quantity": 1,
  "softDescriptor": "BLS*default_descriptor",
  "vendorsInfo": {
    "vendorInfo": [
      {
        "vendorId": 10398032,
        "commissionPercent": 90.2
      }
    ]
  },
  "chargeFrequency": "MONTHLY",
  "trialPeriodDays": "14",
  "recurringChargeAmount": 29.99,
  "currency": "USD",
  "initialChargeAmount": 100.0,
  "autoRenew": true,
  "nextChargeDate": "2020-06-09",
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "zip": "02453",
    "phone": "1234567890"
  },
  "paymentSource": {
    "creditCardInfo": {
      "billingContactInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": "12345"
      },
      "creditCard": {
        "cardLastFourDigits": "1111",
        "cardType": "VISA",
        "cardSubType": "CREDIT",
        "binCategory": "CONSUMER",
        "cardRegulated": "Y",
        "issuingBank": "JPMORGAN CHASE BANK, N.A.",
        "expirationMonth": "07",
        "expirationYear": "2023",
        "issuingCountryCode": "us"
      }
    }
  },
  "charge": {
    "chargeId": 18319019,
    "subscriptionId": 19752551,
    "planId": 2283845,
    "vaultedShopperId": 27567993,
    "transactionId": "1031082549",
    "transactionDate": "2020-05-26",
    "amount": 100.0,
    "currency": "USD",
    "softDescriptor": "BLS*default_descriptor",
    "paymentSource": {
      "creditCardInfo": {
        "billingContactInfo": {
          "firstName": "John",
          "lastName": "Doe",
          "zip": "02453"
        },
        "creditCard": {
          "cardLastFourDigits": "1111",
          "cardType": "VISA",
          "cardSubType": "CREDIT",
          "binCategory": "CONSUMER",
          "cardRegulated": "Y",
          "issuingBank": "JPMORGAN CHASE BANK, N.A.",
          "expirationMonth": "07",
          "expirationYear": "2023",
          "issuingCountryCode": "us"
        }
      }
    },
    "chargeInfo": {
      "fromDate": "2020-05-26",
      "toDate": "2020-06-09",
      "chargeType": "INITIAL"
    },
    "processingInfo": {
      "processingStatus": "SUCCESS",
      "cvvResponseCode": "MA",
      "authorizationCode": "OK1510",
      "avsResponseCodeZip": "U",
      "avsResponseCodeAddress": "U",
      "avsResponseCodeName": "U",
      "networkTransactionId": 16029749259621,
      "transactionRegion": "US"
    },
    "vendorsInfo": {
      "vendorInfo": [
        {
          "vendorId": 10398032,
          "commissionPercent": 90.2
        }
      ]
    }
  },
  "fraudResultInfo": {}
}

{
  "subscriptionId": 87654321,
  "planId": 1234567,
  "vaultedShopperId": 12345678,
  "status": "ACTIVE",
  "quantity": 1,
  "softDescriptor": "BLS*MARKETPLACE",
  "vendorsInfo": {
    "vendorsInfoProcessingStatus": "COMPLETED",
    "vendorInfo": [
      {
        "vendorId": 7654321,
        "commissionAmount": 10.00
      }
    ]
  },
  "chargeFrequency": "DAILY",
  "recurringChargeAmount": 50.00,
  "currency": "USD",
  "initialChargeAmount": 30.00,
  "autoRenew": true,
  "nextChargeDate": "2024-08-16",
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "zip": "12345",
    "phone": "12345678909876"
  },
  "paymentSource": {
    "creditCardInfo": {
      "billingContactInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": "12345"
      },
      "creditCard": {
        "cardLastFourDigits": "1111",
        "cardType": "VISA",
        "cardSubType": "CREDIT",
        "binCategory": "CONSUMER",
        "binNumber": "411111",
        "cardRegulated": "Y",
        "issuingBank": "JPMORGAN CHASE BANK, N.A.",
        "expirationMonth": "10",
        "expirationYear": "2025",
        "issuingCountryCode": "us"
      },
      "dateCreated": "08/15/2024",
      "timeCreated": "07:20:28",
      "dateModified": "08/15/2024",
      "timeModified": "07:20:28"
    }
  },
  "charge": {
    "chargeId": 39959300,
    "subscriptionId": 61293341,
    "planId": 1234567,
    "vaultedShopperId": 78377987,
    "transactionId": "1123843215",
    "transactionDate": "2024-08-15",
    "amount": 30.00,
    "currency": "USD",
    "softDescriptor": "BLS*MARKETPLACE",
    "paymentSource": {
      "creditCardInfo": {
        "billingContactInfo": {
          "firstName": "John",
          "lastName": "Doe",
          "zip": "12345"
        },
        "creditCard": {
          "cardLastFourDigits": "1111",
          "cardType": "VISA",
          "cardSubType": "CREDIT",
          "binCategory": "CONSUMER",
          "cardRegulated": "Y",
          "issuingBank": "JPMORGAN CHASE BANK, N.A.",
          "expirationMonth": "10",
          "expirationYear": "2025",
          "issuingCountryCode": "us"
        }
      }
    },
    "chargeInfo": {
      "fromDate": "2024-08-15",
      "toDate": "2024-08-16",
      "chargeType": "INITIAL"
    },
    "processingInfo": {
      "processingStatus": "SUCCESS",
      "cvvResponseCode": "MA",
      "authorizationCode": "OK1510",
      "avsResponseCodeZip": "U",
      "avsResponseCodeAddress": "U",
      "avsResponseCodeName": "U",
      "networkTransactionId": 16029749259621,
      "transactionRegion": "US"
    },
    "vendorsInfo": {
      "vendorsInfoProcessingStatus": "COMPLETED",
      "vendorInfo": [
        {
          "vendorId": 7654321,
          "commissionAmount": 10.00
        }
      ]
    }
  },
  "fraudResultInfo": {
    "deviceDataCollector": "N"
  },
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "001723731628207",
    "networkTransactionId": "001723731628207"
  }
}

Request Content

Response Details

Examples

Request Examples

Response Examples

API Explorer