{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/recurring/ondemand","auth":"optional","method":"post","settings":"57ee593a21ceb20e0061959e","results":{"codes":[]},"examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Create Merchant-Managed Subscription","type":"endpoint","slug":"create-merchant-managed-subscription","excerpt":"","body":"If you manage your own subscriptions, the Create Merchant-Managed Subscription request lets you set up a merchant-managed subscription, which associates an initial subscription charge with all recurring charges. \n\nTo process recurring subscription charges, you'll send a [Create Merchant-Managed Subscription Charge](doc:create-merchant-managed-subscription-charge) request.\n[block:callout]\n{\n \"type\": \"success\",\n \"title\": \"Merchant-Managed Subscriptions guide\",\n \"body\": \"For more information on working with merchant-managed subscriptions, refer to [Merchant-Managed Subscriptions](doc:subscription-management#section-merchant-managed-subscriptions).\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n`charge` *object* <span style=\"color:#F37500\">**required**</span>, contains the following properties (refer to [charge](doc:charge)):\n `amount` *decimal* <span style=\"color:#F37500\">**required**</span> for ACH/ECP and SEPA Direct Debit; optional otherwise\n `currency` *string* <span style=\"color:#F37500\">**required**</span> \n `vendorsInfo` *object* optional (refer to [vendorsInfo](/v8976-JSON/docs/vendorsinfo)) \n `vaultedShopperId` *integer* optional - do not include if sending `payerInfo`\n `payerInfo` *object* optional - do not include if sending `vaultedShopperId` (refer to [payerInfo](doc:payer-info))\n `paymentSource` *object* <span style=\"color:#F37500\">**required** for `payerInfo`</span>; optional for `vaultedShopperId` (refer to [paymentSource](doc:payment-source))\n `softDescriptor` *string* optional\n `descriptorPhoneNumber` *string* optional\n `authorizedByShopper` *boolean* <span style=\"color:#F37500\">**required**</span> for ACH/ECP and SEPA Direct Debit value must be **true**\n `threeDSecure` *object* optional (refer to [threeDSecure](doc:threedsecure))\n `transactionFraudInfo` *object* optional (refer to [transactionFraudInfo](doc:transaction-fraud-info))\n `transactionMetaData` *object* optional (refer to [transactionMetaData](doc:transaction-meta-data))\n `level3Data` *object* optional (refer to [level3Data](doc:level3data))\n `scheduled` *boolean* optional\n `merchantTransactionId` *string* optional\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response body contains the [charge](doc:charge) resource. \nThe `subscriptionId` appears in the response body (unless payment source was ACH/ECP or SEPA Direct Debit).\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"merchantTransactionId\\\": \\\"MyUniqueOnDemandSubscription\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"securityCode\\\": 111,\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"cardNumber\\\": 4012000033330026\\n }\\n }\\n }\\n}\",\n \"language\": \"curl\",\n \"name\": \"Create Merchant-Managed Subscription request: with credit card\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 45, \\n \\\"currency\\\": \\\"USD\\\", \\n \\\"paymentSource\\\": {\\n \\\"wallet\\\": {\\n \\\"walletType\\\": \\\"APPLE_PAY\\\",\\n \\\"encodedPaymentToken\\\": \\\"eyJhcGlWZXJzaW9uTWlub3IiOjA...\\\"\\n }\\n }\\n}\",\n \"language\": \"curl\",\n \"name\": \"with Apple Pay\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"EUR\\\",\\n \\\"authorizedByShopper\\\": true,\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"fr\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"sepaDirectDebitInfo\\\": {\\n \\\"sepaDirectDebit\\\": {\\n \\\"iban\\\": \\\"DE09100100101234567893\\\"\\n }\\n }\\n }\\n}\",\n \"language\": \"curl\",\n \"name\": \"with SEPA Direct Debit\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 65,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"authorizedByShopper\\\": true,\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"ecpInfo\\\": {\\n \\\"ecp\\\": {\\n \\\"accountNumber\\\": 4099999992, \\n \\\"routingNumber\\\": \\\"011075150\\\",\\n \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\"\\n }\\n }\\n }\\n}\",\n \"language\": \"curl\",\n \"name\": \"with ACH/ECP\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 45, \\n \\\"currency\\\": \\\"USD\\\", \\n \\\"paymentSource\\\": {\\n \\\"wallet\\\": {\\n \\\"walletType\\\": \\\"GOOGLE_PAY\\\",\\n \\\"encodedPaymentToken\\\": \\\"eyJ0b2tliZ2l2ZW5OYW1lIjoiTG9kIiwiY291bnRye…\\\"\\n }\\n } \\n}\",\n \"language\": \"curl\",\n \"name\": \"with Google Pay\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{ \\n \\\"payerInfo\\\":{ \\n \\\"firstName\\\":\\\"PIFirstName\\\",\\n \\\"lastName\\\":\\\"PILastName\\\",\\n \\\"zip\\\":\\\"PIZip\\\",\\n \\\"email\\\":\\\"tt:::at:::gmail.com\\\",\\n \\\"country\\\":\\\"il\\\",\\n \\\"address\\\":\\\"PIaddress1\\\",\\n \\\"address2\\\":\\\"PIaddress2\\\",\\n \\\"city\\\":\\\"PICity\\\"\\n },\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"creditCard\\\":{ \\n \\\"cardNumber\\\":\\\"5555555555554444\\\",\\n \\\"securityCode\\\":\\\"111\\\",\\n \\\"cardType\\\":\\\"MASTERCARD\\\",\\n \\\"expirationMonth\\\":\\\"07\\\",\\n \\\"expirationYear\\\":\\\"2025\\\"\\n },\\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"country\\\":\\\"us\\\",\\n \\\"zip\\\":\\\"BiZip\\\"\\n }\\n }\\n },\\n \\\"amount\\\":\\\"10\\\",\\n \\\"currency\\\":\\\"USD\\\"\\n}\\n\",\n \"language\": \"curl\",\n \"name\": \"New shopper with different billing\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{ \\n \\\"vaultedShopperId\\\":19641554,\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"creditCard\\\":{ \\n \\\"cardNumber\\\":\\\"5555555555554444\\\",\\n \\\"securityCode\\\":\\\"111\\\",\\n \\\"cardType\\\":\\\"MASTERCARD\\\",\\n \\\"expirationMonth\\\":\\\"07\\\",\\n \\\"expirationYear\\\":\\\"2025\\\"\\n },\\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"country\\\":\\\"us\\\",\\n \\\"zip\\\":\\\"BiZip\\\"\\n }\\n }\\n },\\n \\\"amount\\\":\\\"10\\\",\\n \\\"currency\\\":\\\"USD\\\"\\n}\\n\",\n \"language\": \"curl\",\n \"name\": \"Vaulted shopper with billing\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{ \\n \\\"payerInfo\\\":{ \\n \\\"firstName\\\":\\\"PIFirstName\\\",\\n \\\"lastName\\\":\\\"PILastName\\\",\\n \\\"zip\\\":\\\"PIZip\\\",\\n \\\"email\\\":\\\"[email protected]\\\",\\n \\\"country\\\":\\\"il\\\",\\n \\\"address\\\":\\\"PIaddress1\\\",\\n \\\"address2\\\":\\\"PIaddress2\\\",\\n \\\"city\\\":\\\"PICity\\\"\\n },\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"pfToken\\\":\\\"77fdabea752d7a23c763d3690111ffea9d173b34eaa4e8e37d7c59360a167d4a_\\\",\\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"country\\\":\\\"us\\\",\\n \\\"zip\\\":\\\"BiZip\\\"\\n }\\n }\\n },\\n \\\"amount\\\":\\\"10\\\",\\n \\\"currency\\\":\\\"USD\\\"\\n}\",\n \"language\": \"curl\",\n \"name\": \"New shopper with hosted fields and different billing\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{ \\n \\\"vaultedShopperId\\\":19641542,\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"pfToken\\\":\\\"2f1fee480db183617a5e79b340fb2b20954331d6c96b4889a846f95546ef8fc1_\\\",\\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"country\\\":\\\"us\\\",\\n \\\"zip\\\":\\\"BiZip\\\"\\n }\\n }\\n },\\n \\\"amount\\\":\\\"10\\\",\\n \\\"currency\\\":\\\"USD\\\"\\n}\",\n \"language\": \"curl\",\n \"name\": \"Vaulted shopper with hosted fields and different billing\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"merchantTransactionId\\\": \\\"MyUniqueOnDemandSubscription\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"securityCode\\\": 111,\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"cardNumber\\\": 4012000033330026\\n }\\n }\\n },\\n \\\"vendorsInfo\\\": {\\n \\\"vendorInfo\\\": [{ \\\"vendorId\\\": \\\"10398032\\\" }]\\n }\\n}'\",\n \"language\": \"curl\",\n \"name\": \"with vendors info\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": 100,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"merchantTransactionId\\\": \\\"112222\\\",\\n \\\"transactionMetaData\\\": {\\n \\\"metaData\\\": [\\n {\\n \\\"metaValue\\\": 20,\\n \\\"metaKey\\\": \\\"stateTaxAmount\\\",\\n \\\"metaDescription\\\": \\\"State Tax Amount\\\"\\n },\\n {\\n \\\"metaValue\\\": 20,\\n \\\"metaKey\\\": \\\"cityTaxAmount\\\",\\n \\\"metaDescription\\\": \\\"City Tax Amount\\\"\\n },\\n {\\n \\\"metaValue\\\": 10,\\n \\\"metaKey\\\": \\\"shippingAmount\\\",\\n \\\"metaDescription\\\": \\\"Shipping Amount\\\"\\n }\\n ]\\n },\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"92614\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"securityCode\\\": 111,\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"cardNumber\\\": 4111111111111111\\n }\\n }\\n }\\n}'\",\n \"language\": \"curl\",\n \"name\": \"with metadata\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"chargeId\\\": 14837941,\\n \\\"subscriptionId\\\": 13823081,\\n \\\"vaultedShopperId\\\": 23976843,\\n \\\"transactionId\\\": \\\"1020296963\\\",\\n \\\"merchantTransactionId\\\": \\\"MyUniqueOnDemandSubscription\\\",\\n \\\"transactionDate\\\": \\\"2019-03-14\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"binCategory\\\": \\\"CONSUMER\\\",\\n \\\"cardRegulated\\\": \\\"N\\\",\\n \\\"issuingBank\\\": \\\"EXTRAS TEST - VISA\\\",\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"expirationYear\\\": \\\"2023\\\",\\n \\\"issuingCountryCode\\\": \\\"ru\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n },\\n \\\"fraudResultInfo\\\": {\\n \\\"deviceDataCollector\\\": \\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Create Merchant-Managed Subscription response: with credit card\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\": \\\"165323\\\",\\n \\\"subscriptionId\\\": 39518448,\\n \\\"vaultedShopperId\\\": 19559630,\\n \\\"transactionId\\\": \\\"38492608\\\",\\n \\\"transactionDate\\\": \\\"2017-10-13\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"wallet\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Shopper\\\",\\n \\\"address1\\\": \\\"800 South St\\\",\\n \\\"city\\\": \\\"Waltham\\\",\\n \\\"zip\\\": \\\"02453\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with Apple Pay\"\n },\n {\n \"code\": \"{\\n \\\"vaultedShopperId\\\": 22193707,\\n \\\"transactionId\\\": \\\"1015009259\\\",\\n \\\"transactionDate\\\": \\\"2017-10-31\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"EUR\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"sepaDirectDebitInfo\\\": {\\n \\\"sepaDirectDebit\\\": {\\n \\\"ibanFirstFour\\\": \\\"DE09\\\",\\n \\\"ibanLastFour\\\": \\\"7893\\\",\\n \\\"mandateId\\\": \\\"Blu153577\\\",\\n \\\"mandateDate\\\": \\\"31-Oct-17\\\",\\n \\\"preNotificationText\\\": \\\"The amount of 45 EUR will be collected using SEPA Direct Debit with Mandate Blu153577 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.\\\",\\n \\\"preNotificationTranslationRef\\\": \\\"https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1015009259\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"PENDING\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with SEPA Direct Debit\"\n },\n {\n \"code\": \"{\\n \\\"vaultedShopperId\\\": 22330225,\\n \\\"transactionId\\\": \\\"1015609477\\\",\\n \\\"transactionDate\\\": \\\"2018-01-25\\\",\\n \\\"amount\\\": 65,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"ecpInfo\\\": {\\n \\\"ecp\\\": {\\n \\\"accountNumber\\\": \\\"4099999992\\\",\\n \\\"routingNumber\\\": \\\"011075150\\\",\\n \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"PENDING\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with ACH/ECP\"\n },\n {\n \"code\": \"{\\n \\\"vaultedShopperId\\\": 19639434,\\n \\\"transactionId\\\": \\\"38593756\\\",\\n \\\"transactionDate\\\": \\\"2018-11-12\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"wallet\\\": {\\n \\\"walletType\\\": \\\"GOOGLE_PAY\\\",\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"Susan\\\",\\n \\\"lastName\\\": \\\"madden\\\",\\n \\\"address1\\\": \\\"351 Eliot Street\\\",\\n \\\"city\\\": \\\"Milton\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"zip\\\": \\\"02186\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"tokenizedCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"7971\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"dpanExpirationMonth\\\": \\\"9\\\",\\n \\\"dpanExpirationYear\\\": \\\"2025\\\",\\n \\\"dpanLastFourDigits\\\": \\\"2041\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with Google Pay Tokenized CC\"\n },\n {\n \"code\": \"{\\n \\\"vaultedShopperId\\\": 19639432,\\n \\\"transactionId\\\": \\\"38593754\\\",\\n \\\"transactionDate\\\": \\\"2018-11-12\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"1111\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"binCategory\\\": \\\"CONSUMER\\\",\\n \\\"expirationMonth\\\": \\\"12\\\",\\n \\\"expirationYear\\\": \\\"2023\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with Google Pay Non-tokenized CC\"\n },\n {\n \"code\": \"{ \\n \\\"chargeId\\\":251307,\\n \\\"subscriptionId\\\":39598858,\\n \\\"vaultedShopperId\\\":19641864,\\n \\\"transactionId\\\":\\\"38597362\\\",\\n \\\"transactionDate\\\":\\\"2019-01-27\\\",\\n \\\"amount\\\":10.00,\\n \\\"currency\\\":\\\"USD\\\",\\n \\\"softDescriptor\\\":\\\"BLS*Testing\\\",\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"zip\\\":\\\"BiZip\\\",\\n \\\"country\\\":\\\"us\\\"\\n },\\n \\\"creditCard\\\":{ \\n \\\"cardLastFourDigits\\\":\\\"4444\\\",\\n \\\"cardType\\\":\\\"MASTERCARD\\\",\\n \\\"binCategory\\\":\\\"CONSUMER\\\",\\n \\\"expirationMonth\\\":\\\"07\\\",\\n \\\"expirationYear\\\":\\\"2025\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\":{ \\n \\\"chargeType\\\":\\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\":{ \\n \\\"processingStatus\\\":\\\"SUCCESS\\\"\\n },\\n \\\"fraudResultInfo\\\":{ \\n \\\"deviceDataCollector\\\":\\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"New shopper with different billing\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\":251323,\\n \\\"subscriptionId\\\":39598874,\\n \\\"vaultedShopperId\\\":19641880,\\n \\\"transactionId\\\":\\\"38597386\\\",\\n \\\"transactionDate\\\":\\\"2019-01-27\\\",\\n \\\"amount\\\":10.00,\\n \\\"currency\\\":\\\"USD\\\",\\n \\\"softDescriptor\\\":\\\"BLS*Testing\\\",\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"zip\\\":\\\"BiZip\\\",\\n \\\"country\\\":\\\"us\\\"\\n },\\n \\\"creditCard\\\":{ \\n \\\"cardLastFourDigits\\\":\\\"4444\\\",\\n \\\"cardType\\\":\\\"MASTERCARD\\\",\\n \\\"binCategory\\\":\\\"CONSUMER\\\",\\n \\\"expirationMonth\\\":\\\"07\\\",\\n \\\"expirationYear\\\":\\\"2025\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\":{ \\n \\\"chargeType\\\":\\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\":{ \\n \\\"processingStatus\\\":\\\"SUCCESS\\\"\\n },\\n \\\"fraudResultInfo\\\":{ \\n \\\"deviceDataCollector\\\":\\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Vaulted shopper with billing\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\":251317,\\n \\\"subscriptionId\\\":39598868,\\n \\\"vaultedShopperId\\\":19641874,\\n \\\"transactionId\\\":\\\"38597376\\\",\\n \\\"transactionDate\\\":\\\"2019-01-27\\\",\\n \\\"amount\\\":10.00,\\n \\\"currency\\\":\\\"USD\\\",\\n \\\"softDescriptor\\\":\\\"BLS*Testing\\\",\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"zip\\\":\\\"BiZip\\\",\\n \\\"country\\\":\\\"us\\\"\\n },\\n \\\"creditCard\\\":{ \\n \\\"cardLastFourDigits\\\":\\\"0005\\\",\\n \\\"cardType\\\":\\\"AMEX\\\",\\n \\\"binCategory\\\":\\\"CONSUMER\\\",\\n \\\"expirationMonth\\\":\\\"11\\\",\\n \\\"expirationYear\\\":\\\"2024\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\":{ \\n \\\"chargeType\\\":\\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\":{ \\n \\\"processingStatus\\\":\\\"SUCCESS\\\"\\n },\\n \\\"fraudResultInfo\\\":{ \\n \\\"deviceDataCollector\\\":\\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"New shopper with hosted fields and different billing\"\n },\n {\n \"code\": \"{ \\n \\\"chargeId\\\":251311,\\n \\\"subscriptionId\\\":39598862,\\n \\\"vaultedShopperId\\\":19641868,\\n \\\"transactionId\\\":\\\"38597370\\\",\\n \\\"transactionDate\\\":\\\"2019-01-27\\\",\\n \\\"amount\\\":10.00,\\n \\\"currency\\\":\\\"USD\\\",\\n \\\"softDescriptor\\\":\\\"BLS*Testing\\\",\\n \\\"paymentSource\\\":{ \\n \\\"creditCardInfo\\\":{ \\n \\\"billingContactInfo\\\":{ \\n \\\"firstName\\\":\\\"BiFirstName\\\",\\n \\\"lastName\\\":\\\"BiLastName\\\",\\n \\\"address1\\\":\\\"BiAddress1\\\",\\n \\\"address2\\\":\\\"BiAddress2\\\",\\n \\\"city\\\":\\\"BiCity\\\",\\n \\\"state\\\":\\\"CA\\\",\\n \\\"zip\\\":\\\"BiZip\\\",\\n \\\"country\\\":\\\"us\\\"\\n },\\n \\\"creditCard\\\":{ \\n \\\"cardLastFourDigits\\\":\\\"0005\\\",\\n \\\"cardType\\\":\\\"AMEX\\\",\\n \\\"binCategory\\\":\\\"CONSUMER\\\",\\n \\\"expirationMonth\\\":\\\"11\\\",\\n \\\"expirationYear\\\":\\\"2024\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\":{ \\n \\\"chargeType\\\":\\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\":{ \\n \\\"processingStatus\\\":\\\"SUCCESS\\\"\\n },\\n \\\"fraudResultInfo\\\":{ \\n \\\"deviceDataCollector\\\":\\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Vaulted shopper with hosted fields and different billing\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\": 14837941,\\n \\\"subscriptionId\\\": 13823081,\\n \\\"vaultedShopperId\\\": 23976843,\\n \\\"transactionId\\\": \\\"1020296963\\\",\\n \\\"merchantTransactionId\\\": \\\"MyUniqueOnDemandSubscription\\\",\\n \\\"transactionDate\\\": \\\"2019-03-14\\\",\\n \\\"amount\\\": 45,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*Testing\\\",\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"binCategory\\\": \\\"CONSUMER\\\",\\n \\\"cardRegulated\\\": \\\"N\\\",\\n \\\"issuingBank\\\": \\\"EXTRAS TEST - VISA\\\",\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"expirationYear\\\": \\\"2023\\\",\\n \\\"issuingCountryCode\\\": \\\"ru\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n \\\"authorizationCode\\\": \\\"654321\\\"\\n },\\n \\\"fraudResultInfo\\\": {\\n \\\"deviceDataCollector\\\": \\\"N\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with Authorization Code\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\": 18319053,\\n \\\"subscriptionId\\\": 19752665,\\n \\\"vaultedShopperId\\\": 27568045,\\n \\\"transactionId\\\": \\\"1031082689\\\",\\n \\\"merchantTransactionId\\\": \\\"MyUniqueOnDemandSubscription\\\",\\n \\\"transactionDate\\\": \\\"2020-05-26\\\",\\n \\\"amount\\\": 45.0,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*default_descriptor\\\",\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"binCategory\\\": \\\"CONSUMER\\\",\\n \\\"cardRegulated\\\": \\\"N\\\",\\n \\\"issuingBank\\\": \\\"EXTRAS TEST - VISA\\\",\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"expirationYear\\\": \\\"2023\\\",\\n \\\"issuingCountryCode\\\": \\\"ru\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n \\\"authorizationCode\\\": \\\"654321\\\"\\n },\\n \\\"vendorsInfo\\\": {\\n \\\"vendorInfo\\\": [\\n {\\n \\\"vendorId\\\": 10398032,\\n \\\"commissionPercent\\\": 90.2\\n }\\n ]\\n },\\n \\\"fraudResultInfo\\\": {}\\n}\",\n \"language\": \"json\",\n \"name\": \"with vendors info\"\n },\n {\n \"code\": \"{\\n \\\"chargeId\\\": 20400685,\\n \\\"subscriptionId\\\": 23451699,\\n \\\"vaultedShopperId\\\": 29970021,\\n \\\"transactionId\\\": \\\"1039090759\\\",\\n \\\"merchantTransactionId\\\": \\\"112222\\\",\\n \\\"transactionDate\\\": \\\"2020-12-28\\\",\\n \\\"amount\\\": 100,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"softDescriptor\\\": \\\"BLS*default_descriptor\\\",\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"92614\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"1111\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"binCategory\\\": \\\"CONSUMER\\\",\\n \\\"cardRegulated\\\": \\\"Y\\\",\\n \\\"issuingBank\\\": \\\"JPMORGAN CHASE BANK, N.A.\\\",\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"expirationYear\\\": \\\"2023\\\",\\n \\\"issuingCountryCode\\\": \\\"us\\\"\\n }\\n }\\n },\\n \\\"chargeInfo\\\": {\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n \\\"authorizationCode\\\": \\\"654321\\\"\\n },\\n \\\"fraudResultInfo\\\": {}\\n}\",\n \"language\": \"json\",\n \"name\": \"with metadata\"\n }\n ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\n\n###Create Merchant-Managed Subscription: with credit card\nThis example shows a Create Merchant-Managed Subscription request with a credit card and a new shopper, with details about the shopper and their payment method. \n\n###Create Merchant-Managed Subscription: with Apple Pay\nThis example shows a Create Merchant-Managed Subscription request with an Apple Pay wallet. In the request, include the `encodedPaymentToken` inside `orderingShopper` > `wallet`, also supply `walletType` of `APPLE_PAY` there. The response will contain a `shopper-id` property to use to process future transactions with the shopper. Refer to the [Apple Pay Guide](/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app) for more information.\n\n**Note:** To test Apple Pay, follow the steps in the [Apple Pay Guide](/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app). The API Explorer does not support Apple Pay testing. \n\n###Create Merchant-Managed Subscription: with SEPA Direct Debit\nThis example shows a Create Merchant-Managed Subscription request with a new shopper with the SEPA Direct Debit payment method. In the request, include `authorizedByShopper` with a value set to **true** to indicate that you've collected the shopper's [mandate acceptance](/docs/sepa-direct-debit#section-step-1-collect-a-mandate-acceptance-from-your-shopper). Include the shopper's bank account details within `paymentSource` > `sepaDirectDebitInfo` > `sepaDirectDebit`. \n\n**Note:** `subscriptionId` will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 5 - 6 business days). You will then be informed of the subscription ID via `Charge` webhook or via [Retrieve Specific Charge](doc:retrieve-specific-charge) request. \n\n###Create Merchant-Managed Subscription: with ACH/ECP\nThis example shows a Create Merchant-Managed Subscription request with a new shopper with the ACH/ECP payment method. In the request, include `authorizedByShopper` with a value set to **true** to indicate that you've collected the shopper's permission to debit their account. Include the shopper's bank account details within `paymentSource` > `ecpInfo` > `ecp`. If you would like to process the transaction for a returning shopper, pass an empty `ecpInfo` object. \n\n**Note:** `subscriptionId` will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 2 business days). You will then be informed of the subscription ID via `Charge` webhook or via [Retrieve Specific Charge](doc:retrieve-specific-charge) request. \n\n###Create Merchant-Managed Subscription: with Google Pay™\nThis example shows a Create Merchant-Managed Subscription request with a Google Pay wallet. In the request, include `walletType` = GOOGLE_PAY and `encodedPaymentToken` inside `wallet`. refer to the [Google Pay Guide](doc:google-pay) for more information.\n\n###New shopper with different billing\nThis example shows a Create Merchant-Managed Subscription request with a new shopper whose contact details are different from the credit card billing information.\n\n###Vaulted shopper with billing\nThis example shows a Create Merchant-Managed Subscription request for an existing shopper with existing credit card information.\n\n###New shopper with hosted fields and different billing\nThis example shows a Create Merchant-Managed Subscription request for Hosted Payment Fields for a new shopper whose contact details are different from the credit card billing information. \n\n###Vaulted shopper with hosted fields and different billing\nThis example shows a Create Merchant-Managed Subscription request for Hosted Payment Fields for a an existing shopper with existing credit card information.\n\n###Vendors info\nThis example shows a Create Merchant-Managed Subscription request with a Marketplace vendor. Include `vendorsInfo` in the request to process a transaction involving one or more vendors. For more details, refer to the [Marketplace Guide](/docs/marketplace-overview).\n\n###Metadata\nTo send metadata for the transaction, include `transactionMetaData` in the request. The above example request includes metadata for state tax, city tax, and the shipping amount.\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the JSON portion of the request below and then click **Try it!**\n\n**Tip**: Use the JSON code below as a starting point. You can enter different parameter values to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"amount\\\": 45, \\n \\\"currency\\\": \\\"USD\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"paymentSource\\\": {\\n \\\"creditCardInfo\\\": {\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"securityCode\\\": 111,\\n \\\"expirationMonth\\\": \\\"05\\\",\\n \\\"cardNumber\\\": 4012000033330026\\n }\\n }\\n }\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff39c12e2e8fa00503ad5c1","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff39c12e2e8fa00503ad52d","5ff39c12e2e8fa00503ad52e","5ff39c12e2e8fa00503ad52f","5ff39c12e2e8fa00503ad530","5ff39c12e2e8fa00503ad531","5ff39c12e2e8fa00503ad532","5ff39c12e2e8fa00503ad533","5ff39c12e2e8fa00503ad534","5ff39c12e2e8fa00503ad535","5ff39c12e2e8fa00503ad536","5ff39c12e2e8fa00503ad537","5ff39c12e2e8fa00503ad538","5ff39c12e2e8fa00503ad539","5ff39c12e2e8fa00503ad53a","5ff39c12e2e8fa00503ad53b","5ff39c12e2e8fa00503ad53c","5ff39c12e2e8fa00503ad53d","5ff39c12e2e8fa00503ad53e","5ff39c12e2e8fa00503ad53f"],"_id":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fc6c6094cb8fa066b0d2ea3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Subscriptions","slug":"subscriptions","order":10,"from_sync":false,"reference":false,"_id":"5ff39c12e2e8fa00503ad534","version":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-07-27T10:22:06.636Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-01-16T19:42:51.850Z","__v":0,"parentDoc":null}
postCreate Merchant-Managed Subscription
Definition
Documentation
If you manage your own subscriptions, the Create Merchant-Managed Subscription request lets you 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
object required, contains the following properties (refer to charge):
amount
decimal required for ACH/ECP and SEPA Direct Debit; optional otherwise
currency
string required
vendorsInfo
object optional (refer to vendorsInfo)
vaultedShopperId
integer optional - do not include if sending payerInfo
payerInfo
object optional - do not include if sending vaultedShopperId
(refer to payerInfo)
paymentSource
object required for payerInfo
; optional for vaultedShopperId
(refer to paymentSource)
softDescriptor
string optional
descriptorPhoneNumber
string optional
authorizedByShopper
boolean required for ACH/ECP and SEPA Direct Debit value must be true
threeDSecure
object optional (refer to threeDSecure)
transactionFraudInfo
object optional (refer to transactionFraudInfo)
transactionMetaData
object optional (refer to transactionMetaData)
level3Data
object optional (refer to level3Data)
scheduled
boolean optional
merchantTransactionId
string optional
Response Details
If successful, the response HTTP status code is 200 OK.
The response body contains the charge resource.
The subscriptionId
appears in the response body (unless payment source was ACH/ECP or SEPA Direct Debit).
Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 45,
"currency": "USD",
"merchantTransactionId": "MyUniqueOnDemandSubscription",
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"paymentSource": {
"creditCardInfo": {
"creditCard": {
"expirationYear": 2023,
"securityCode": 111,
"expirationMonth": "05",
"cardNumber": 4012000033330026
}
}
}
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 45,
"currency": "USD",
"paymentSource": {
"wallet": {
"walletType": "APPLE_PAY",
"encodedPaymentToken": "eyJhcGlWZXJzaW9uTWlub3IiOjA..."
}
}
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 45,
"currency": "EUR",
"authorizedByShopper": true,
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "fr"
},
"paymentSource": {
"sepaDirectDebitInfo": {
"sepaDirectDebit": {
"iban": "DE09100100101234567893"
}
}
}
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 65,
"currency": "USD",
"authorizedByShopper": true,
"payerInfo": {
"firstName": "Jane",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"paymentSource": {
"ecpInfo": {
"ecp": {
"accountNumber": 4099999992,
"routingNumber": "011075150",
"accountType": "CONSUMER_CHECKING"
}
}
}
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 45,
"currency": "USD",
"paymentSource": {
"wallet": {
"walletType": "GOOGLE_PAY",
"encodedPaymentToken": "eyJ0b2tliZ2l2ZW5OYW1lIjoiTG9kIiwiY291bnRye…"
}
}
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: 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"
}
}
},
"amount":"10",
"currency":"USD"
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"vaultedShopperId":19641554,
"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"
}
}
},
"amount":"10",
"currency":"USD"
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: 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":"77fdabea752d7a23c763d3690111ffea9d173b34eaa4e8e37d7c59360a167d4a_",
"billingContactInfo":{
"firstName":"BiFirstName",
"lastName":"BiLastName",
"address1":"BiAddress1",
"address2":"BiAddress2",
"city":"BiCity",
"state":"CA",
"country":"us",
"zip":"BiZip"
}
}
},
"amount":"10",
"currency":"USD"
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"vaultedShopperId":19641542,
"paymentSource":{
"creditCardInfo":{
"pfToken":"2f1fee480db183617a5e79b340fb2b20954331d6c96b4889a846f95546ef8fc1_",
"billingContactInfo":{
"firstName":"BiFirstName",
"lastName":"BiLastName",
"address1":"BiAddress1",
"address2":"BiAddress2",
"city":"BiCity",
"state":"CA",
"country":"us",
"zip":"BiZip"
}
}
},
"amount":"10",
"currency":"USD"
}
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 45,
"currency": "USD",
"merchantTransactionId": "MyUniqueOnDemandSubscription",
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"paymentSource": {
"creditCardInfo": {
"creditCard": {
"expirationYear": 2023,
"securityCode": 111,
"expirationMonth": "05",
"cardNumber": 4012000033330026
}
}
},
"vendorsInfo": {
"vendorInfo": [{ "vendorId": "10398032" }]
}
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/ondemand \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 100,
"currency": "USD",
"merchantTransactionId": "112222",
"transactionMetaData": {
"metaData": [
{
"metaValue": 20,
"metaKey": "stateTaxAmount",
"metaDescription": "State Tax Amount"
},
{
"metaValue": 20,
"metaKey": "cityTaxAmount",
"metaDescription": "City Tax Amount"
},
{
"metaValue": 10,
"metaKey": "shippingAmount",
"metaDescription": "Shipping Amount"
}
]
},
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "92614",
"country": "us"
},
"paymentSource": {
"creditCardInfo": {
"creditCard": {
"expirationYear": 2023,
"securityCode": 111,
"expirationMonth": "05",
"cardNumber": 4111111111111111
}
}
}
}'
{
"chargeId": 14837941,
"subscriptionId": 13823081,
"vaultedShopperId": 23976843,
"transactionId": "1020296963",
"merchantTransactionId": "MyUniqueOnDemandSubscription",
"transactionDate": "2019-03-14",
"amount": 45,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"creditCardInfo": {
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC",
"binCategory": "CONSUMER",
"cardRegulated": "N",
"issuingBank": "EXTRAS TEST - VISA",
"expirationMonth": "05",
"expirationYear": "2023",
"issuingCountryCode": "ru"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS"
},
"fraudResultInfo": {
"deviceDataCollector": "N"
}
}
{
"chargeId": "165323",
"subscriptionId": 39518448,
"vaultedShopperId": 19559630,
"transactionId": "38492608",
"transactionDate": "2017-10-13",
"amount": 45,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"wallet": {
"billingContactInfo": {
"firstName": "Jane",
"lastName": "Shopper",
"address1": "800 South St",
"city": "Waltham",
"zip": "02453",
"country": "us"
},
}
},
"chargeInfo": {
"chargeType": "INITIAL"
}
}
{
"vaultedShopperId": 22193707,
"transactionId": "1015009259",
"transactionDate": "2017-10-31",
"amount": 45,
"currency": "EUR",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"sepaDirectDebitInfo": {
"sepaDirectDebit": {
"ibanFirstFour": "DE09",
"ibanLastFour": "7893",
"mandateId": "Blu153577",
"mandateDate": "31-Oct-17",
"preNotificationText": "The amount of 45 EUR will be collected using SEPA Direct Debit with Mandate Blu153577 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.",
"preNotificationTranslationRef": "https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1015009259"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "PENDING"
}
}
{
"vaultedShopperId": 22330225,
"transactionId": "1015609477",
"transactionDate": "2018-01-25",
"amount": 65,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"ecpInfo": {
"ecp": {
"accountNumber": "4099999992",
"routingNumber": "011075150",
"accountType": "CONSUMER_CHECKING"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "PENDING"
}
}
{
"vaultedShopperId": 19639434,
"transactionId": "38593756",
"transactionDate": "2018-11-12",
"amount": 45,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"wallet": {
"walletType": "GOOGLE_PAY",
"billingContactInfo": {
"firstName": "Susan",
"lastName": "madden",
"address1": "351 Eliot Street",
"city": "Milton",
"state": "MA",
"zip": "02186",
"country": "us"
},
"tokenizedCard": {
"cardLastFourDigits": "7971",
"cardType": "VISA",
"cardSubType": "CREDIT",
"dpanExpirationMonth": "9",
"dpanExpirationYear": "2025",
"dpanLastFourDigits": "2041"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS"
}
}
{
"vaultedShopperId": 19639432,
"transactionId": "38593754",
"transactionDate": "2018-11-12",
"amount": 45,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"creditCardInfo": {
"creditCard": {
"cardLastFourDigits": "1111",
"cardType": "VISA",
"binCategory": "CONSUMER",
"expirationMonth": "12",
"expirationYear": "2023"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS"
}
}
{
"chargeId":251307,
"subscriptionId":39598858,
"vaultedShopperId":19641864,
"transactionId":"38597362",
"transactionDate":"2019-01-27",
"amount":10.00,
"currency":"USD",
"softDescriptor":"BLS*Testing",
"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":{
"chargeType":"INITIAL"
},
"processingInfo":{
"processingStatus":"SUCCESS"
},
"fraudResultInfo":{
"deviceDataCollector":"N"
}
}
{
"chargeId":251323,
"subscriptionId":39598874,
"vaultedShopperId":19641880,
"transactionId":"38597386",
"transactionDate":"2019-01-27",
"amount":10.00,
"currency":"USD",
"softDescriptor":"BLS*Testing",
"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":{
"chargeType":"INITIAL"
},
"processingInfo":{
"processingStatus":"SUCCESS"
},
"fraudResultInfo":{
"deviceDataCollector":"N"
}
}
{
"chargeId":251317,
"subscriptionId":39598868,
"vaultedShopperId":19641874,
"transactionId":"38597376",
"transactionDate":"2019-01-27",
"amount":10.00,
"currency":"USD",
"softDescriptor":"BLS*Testing",
"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":{
"chargeType":"INITIAL"
},
"processingInfo":{
"processingStatus":"SUCCESS"
},
"fraudResultInfo":{
"deviceDataCollector":"N"
}
}
{
"chargeId":251311,
"subscriptionId":39598862,
"vaultedShopperId":19641868,
"transactionId":"38597370",
"transactionDate":"2019-01-27",
"amount":10.00,
"currency":"USD",
"softDescriptor":"BLS*Testing",
"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":{
"chargeType":"INITIAL"
},
"processingInfo":{
"processingStatus":"SUCCESS"
},
"fraudResultInfo":{
"deviceDataCollector":"N"
}
}
{
"chargeId": 14837941,
"subscriptionId": 13823081,
"vaultedShopperId": 23976843,
"transactionId": "1020296963",
"merchantTransactionId": "MyUniqueOnDemandSubscription",
"transactionDate": "2019-03-14",
"amount": 45,
"currency": "USD",
"softDescriptor": "BLS*Testing",
"paymentSource": {
"creditCardInfo": {
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC",
"binCategory": "CONSUMER",
"cardRegulated": "N",
"issuingBank": "EXTRAS TEST - VISA",
"expirationMonth": "05",
"expirationYear": "2023",
"issuingCountryCode": "ru"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS",
"authorizationCode": "654321"
},
"fraudResultInfo": {
"deviceDataCollector": "N"
}
}
{
"chargeId": 18319053,
"subscriptionId": 19752665,
"vaultedShopperId": 27568045,
"transactionId": "1031082689",
"merchantTransactionId": "MyUniqueOnDemandSubscription",
"transactionDate": "2020-05-26",
"amount": 45.0,
"currency": "USD",
"softDescriptor": "BLS*default_descriptor",
"paymentSource": {
"creditCardInfo": {
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC",
"binCategory": "CONSUMER",
"cardRegulated": "N",
"issuingBank": "EXTRAS TEST - VISA",
"expirationMonth": "05",
"expirationYear": "2023",
"issuingCountryCode": "ru"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS",
"authorizationCode": "654321"
},
"vendorsInfo": {
"vendorInfo": [
{
"vendorId": 10398032,
"commissionPercent": 90.2
}
]
},
"fraudResultInfo": {}
}
{
"chargeId": 20400685,
"subscriptionId": 23451699,
"vaultedShopperId": 29970021,
"transactionId": "1039090759",
"merchantTransactionId": "112222",
"transactionDate": "2020-12-28",
"amount": 100,
"currency": "USD",
"softDescriptor": "BLS*default_descriptor",
"paymentSource": {
"creditCardInfo": {
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "92614",
"country": "us"
},
"creditCard": {
"cardLastFourDigits": "1111",
"cardType": "VISA",
"cardSubType": "CREDIT",
"binCategory": "CONSUMER",
"cardRegulated": "Y",
"issuingBank": "JPMORGAN CHASE BANK, N.A.",
"expirationMonth": "05",
"expirationYear": "2023",
"issuingCountryCode": "us"
}
}
},
"chargeInfo": {
"chargeType": "INITIAL"
},
"processingInfo": {
"processingStatus": "SUCCESS",
"authorizationCode": "654321"
},
"fraudResultInfo": {}
}
Example Descriptions
Create Merchant-Managed Subscription: with credit card
This example shows a Create Merchant-Managed Subscription request with a credit card and a new shopper, with details about the shopper and their payment method.
Create Merchant-Managed Subscription: with Apple Pay
This example shows a Create Merchant-Managed Subscription request with an Apple Pay wallet. In the request, include the encodedPaymentToken
inside orderingShopper
> wallet
, also supply walletType
of APPLE_PAY
there. The response will contain a shopper-id
property to use to process future transactions with the shopper. Refer to the Apple Pay Guide for more information.
Note: To test Apple Pay, follow the steps in the Apple Pay Guide. The API Explorer does not support Apple Pay testing.
Create Merchant-Managed Subscription: with SEPA Direct Debit
This example shows a Create Merchant-Managed Subscription request with a new shopper with the SEPA Direct Debit payment method. In the request, include authorizedByShopper
with a value set to true to indicate that you've collected the shopper's mandate acceptance. Include the shopper's bank account details within paymentSource
> sepaDirectDebitInfo
> sepaDirectDebit
.
Note: subscriptionId
will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 5 - 6 business days). You will then be informed of the subscription ID via Charge
webhook or via Retrieve Specific Charge request.
Create Merchant-Managed Subscription: with ACH/ECP
This example shows a Create Merchant-Managed Subscription request with a new shopper with the ACH/ECP payment method. In the request, include authorizedByShopper
with a value set to true to indicate that you've collected the shopper's permission to debit their account. Include the shopper's bank account details within paymentSource
> ecpInfo
> ecp
. If you would like to process the transaction for a returning shopper, pass an empty ecpInfo
object.
Note: subscriptionId
will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 2 business days). You will then be informed of the subscription ID via Charge
webhook or via Retrieve Specific Charge request.
Create Merchant-Managed Subscription: with Google Pay™
This example shows a Create Merchant-Managed Subscription request with a Google Pay wallet. In the request, include walletType
= GOOGLE_PAY and encodedPaymentToken
inside wallet
. refer to the Google Pay Guide for more information.
New shopper with different billing
This example shows a Create Merchant-Managed Subscription request with a new shopper whose contact details are different from the credit card billing information.
Vaulted shopper with billing
This example shows a Create Merchant-Managed Subscription request for an existing shopper with existing credit card information.
New shopper with hosted fields and different billing
This example shows a Create Merchant-Managed Subscription request for Hosted Payment Fields for a new shopper whose contact details are different from the credit card billing information.
Vaulted shopper with hosted fields and different billing
This example shows a Create Merchant-Managed Subscription request for Hosted Payment Fields for a an existing shopper with existing credit card information.
Vendors info
This example shows a Create Merchant-Managed Subscription request with a Marketplace vendor. Include vendorsInfo
in the request to process a transaction involving one or more vendors. For more details, refer to the Marketplace Guide.
Metadata
To send metadata for the transaction, include transactionMetaData
in the request. The above example request includes metadata for state tax, city tax, and the shipping amount.
Back to Top
API Explorer
To test out a call, enter the JSON portion of the request below and then click Try it!
Tip: Use the JSON code below as a starting point. You can enter different parameter values to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.
{
"amount": 45,
"currency": "USD",
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"zip": "12345",
"country": "us"
},
"paymentSource": {
"creditCardInfo": {
"creditCard": {
"expirationYear": 2023,
"securityCode": 111,
"expirationMonth": "05",
"cardNumber": 4012000033330026
}
}
}
}