LogoLogo
  • Welcome to Subscribe
    • Introduction to Subscribe
    • Subscribe Release Notes
      • 2025 Releases
        • 2025.2
        • 2025.1
      • 3.17.0 Major Release
        • 3.17.0.x Hotfixes
        • 3.17.1 Minor Release
          • 3.17.1.x Hotfixes
        • 3.17.2 Minor Release
      • 3.16.0
        • 3.16.0.X Hotfixes
        • 3.16.1 Minor Release
          • 3.16.1.X Hotfixes
        • 3.16.2 Minor Release
          • 3.16.2.X Hotfixes
        • 3.16.3 Minor Release
          • 3.16.3.x Hotfixes
          • 3.16.3.x Hotfixes (Continued)
      • 3.15.0 and 3.15+
      • 3.14 and 3.14+
      • 3.13.0 and 3.13+
      • 3.12
      • 3.11
      • 3.10
      • 2.X Releases
    • Coming Soon: What's On Your Way
    • NCS Circ Service Packs
      • 2018.5 Service Pack 1
      • 2018.5 Service Pack 2
      • 2018.5 Service Pack 3
      • 2018.5 Service Pack 4
      • 2020.2.0 Version
      • 2020.2.1 Version
      • 2020.2.2 Version
      • 2020.3.0 Version
      • 2020.4.0 Version
        • 2020.4.0 Version - Resolved Issues
        • 2020.4.0 - Enhancements
  • Naviga Applications and User Guides
    • Landing Application User Guide
      • Create a New User
      • Editing User Details
      • Exporting the Users
      • Password Settings
    • Solicitor Concierge User Guide
      • Solicitor Quickstart
      • Find your way around the Solicitor UI
      • Tutorials
        • Audit Trail
        • Configure available areas
        • Configure a sales product
        • Configure marketing text
        • Configure terms and conditions
        • Configure premiums
        • Configure an offer group
        • Configure an activation fee
        • Configure users, sales teams, and team members
          • Best practices for user accounts
          • Roles and permissions matrix
        • Import or Export Solicitor Data
        • Reference tables
    • CSR User Guide
      • Account information
      • Subscription Search
      • New Subscription Registration
      • Sending Invites
      • Create a new subscription
      • Digital Product Management
      • Disclaimer Management
      • Registration Management
      • NCS Only
        • Delivery Issues and Delivery Management
        • Billing and payment management
        • Address management
        • Update Solicitation Preference
        • Upgrades and downgrades management
        • Temporarily stop a subscription
        • Permanently stop a subscription
        • Create a vacation transfer
        • Redirect to classic portal
        • Restart a Subscription
      • Matrix Only
        • Billing and payment management
      • Show events and access events
    • Subscription Panel User Guide
      • Overview
      • Tutorials, how-tos, and reference documentation
        • Component Matrix
        • Create, edit, or remove component properties
          • Common properties quickstart
        • Create, edit, or delete a Presentation Template
        • Create, edit, delete, import or export Presentations
        • Preview a Presentation
        • Tutorials and Step-by-step guides
        • Reference documentation
          • Analytics
          • Presentation URLs
    • CMS User Guide
      • Overview
      • Tutorials, how-tos
        • How to Create a New Page
        • How to Manage Attributes
        • How to Manage Benefits
        • How to Manage Rewards
        • How to Manage Content and Pages
        • How to Manage the FAQ Section
        • How to Manage Images
        • How to Manage Slideshows
        • How to Manage Navigation: Links, Menu, Footer
        • How to Manage Notifications
        • How to Manage Newspapers (Divisions) And Newspaper Groups
  • Subscribe Features
    • New Starts and Restarts
      • Active Subscription Check
      • New starts
        • Complimentary (free-of-charge) subscriptions
        • 'Day Pass' Subscriptions (NCS Circ)
        • Gift Subscriptions (NCS Circ)
        • Lite Subscriptions
        • Trial-with-Payment subscriptions (NCS Circ)
        • Country-Only-Start Subscriptions (NCS Circ)
        • Auth0 Email Verification
        • Real-time Entitlements (NCS Circ)
      • Occupant creation/update during a new start (NCS Circ)
      • PurchaseAPI and failed starts reprocessing
      • Restarts (NCS Circ)
      • Restarts (Matrix)
    • Payment features (NCS Circ)
      • Tip: One-time and Recurring (NCS Circ)
      • Activation fees (NCS Circ)
      • One-time payment and Auto-renew (NCS circ)
      • Apple Pay: NCS Circ, Payway & Braintree
      • Google Pay: NCS Circ, Payway / Braintree
      • Variable Pricing (NCS Circ)
    • Upgrades and Downgrades
    • Stop Saver (NCS Circ)
    • Multicurrency (Vindicia only)
      • Multicurrency set up user guide
    • Occupant data update
  • ADDITIONAL RESOURCES
    • Subscribe APIs
      • Purchase API 3.17.1.2
      • Newsletter Widget API
      • InApp API (External Payments)
      • Newstart InApp (Webhooks)
      • Subscription API
      • Entitlements API Reference
      • Firefly
    • Workflows
      • Make a Payment Workflow
      • Auto-renew Workflows
      • NCS Only
        • eBill Workflows
        • Vacation Transfer Workflow
        • Permanent Stop Workflow
        • Temporary Stop Workflow
        • Solicitation Preference Workflow
        • Delivery Issues Workflow
        • Address Management Workflow
        • Restarts
        • Subscription Purchase Workflows
      • Matrix Only
        • New Start (Matrix)
      • CircPro Only
        • New start Workflow
        • Complaints Workflow
        • Update Payment Information Workflow
        • Switch to Invoice Workflow
        • One Time Payment Workflow
        • Temporary Stop Workflow
      • New Start Flow
      • Move Flow
    • Videos & Webinars
Powered by GitBook
On this page
  • Introduction
  • Purchases API
  • Newly added Parameters in /Purchases API 3.17.1.2
  • 200 Responses
  • Request Examples

Was this helpful?

Export as PDF
  1. ADDITIONAL RESOURCES
  2. Subscribe APIs

Purchase API 3.17.1.2

DISCLAIMER

Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.

Introduction

Currently, when a request is made to Purchases API, it utilizes the payment information, authorizes it, and captures the payment. Then the subscription request is submitted to the Circ system.

An extended flow of Purchase API has now been implemented wherein the authorization and capture will not be performed. Rather, when the processed payment information is provided by the consumer application, it is validated, and the same will be sent to Circ to create the subscription.

A flag parameter 'PaymentAuthCaptured” has been introduced to control this flow. If the value of this flag parameter is true, this modified extended flow of Purchases API will take precedence. The events AUTHCC and CCFUNDCAPTURE will not take place. If the flag value is false, the existing flow happens.

Purchases API

Call this endpoint to create a subscription. This applies only to versions from 3.17.1.2.

POST

/Purchases

Header

Authorization

string

Yes

Header

X-SourceSystem

string

Yes

Header

X-MediaGroupCode

string

Yes

Header

X-ClientCode

string

Yes

Header

X-PaperCode

string

Yes

Path

SubscriptionId

integer

Yes

Body

StartDate

datetime

Yes

Body

ExpirationDate

datetime

No

Body

CustomerRegistrationId

string

Yes

Body

EmailAddress

string

Yes

Body

OfferId

integer

Yes

Body

OfferGroupId

integer

Yes

Body

RecipientInformation.FirstName

string

No

Body

RecipientInformation.LastName

string

No

Body

RecipientInformation.Email

string

No

Body

RecipientInformation.GiftMessage

string

No

Body

DeliveryAddress.FirstName

string

No

Body

DeliveryAddress.LastName

string

No

Body

DeliveryAddress.Company

string

No

Body

DeliveryAddress.Address

string

No

Body

DeliveryAddress.AptNumber

string

No

Body

DeliveryAddress.AptUnit

string

No

Body

DeliveryAddress.City

string

No

Body

DeliveryAddress.State

string

No

Body

DeliveryAddress.ZipCode

string

No

Body

DeliveryAddress.CountryCode

string

No

Body

DeliveryAddress.Phone

string

No

Body

BillingAddress.FirstName

string

No

Body

BillingAddress.LastName

string

No

Body

BillingAddress.Company

string

No

Body

BillingAddress.Address

string

No

Body

BillingAddress.AptNumber

string

No

Body

BillingAddress.AptUnit

string

No

Body

BillingAddress.City

string

No

Body

BillingAddress.State

string

No

Body

BillingAddress.ZipCode

string

No

Body

BillingAddress.CountryCode

string

No

Body

BillingAddress.Phone

string

No

Body

PaymentTypeId

integer

No

Body

CreditCard.Type

string

No

Body

CreditCard.Number

string

No

Body

CreditCard.ExpirationYear

sting

No

Body

CreditCard.ExpirationMonth

string

No

Body

CreditCard.OwnerName

string

No

Body

BankAccount.AccountTyp

string

No

Body

BankAccount.InstitutionName

string

No

Body

BankAccount.AccountNumber

string

No

Body

BankAccount.RoutingNumber

string

No

Body

BankAccount.NumberLastFourDigits

string

No

Body

PayPalInfo.PayerId

string

No

Body

PayPalInfo.PaypalEmail

string

No

Body

PayPalInfo.ReturnUrl

string

No

Body

PayPalInfo.CancelUrl

string

No

Body

PayPalInfo.PaymentId

string

No

Body

SpreedlyInfo.RedirectUrl

string

No

Body

SpreedlyInfo.CallbackUrl

string

No

Body

SpreedlyInfo.BrowserInfo

string

No

Body

ActivateEZPay

boolean

No

Body

Amount.AmountCharged

decimal

No

Body

Amount.ActivationFee

decimal

No

Body

Amount.TaxAmount

decimal

No

Body

Amount.SubscriptionCost

decimal

No

Body

ExternalPaymentMethodId

string

No

Body

ExternalCustomerId

string

No

Body

ValidateAddress

boolean

No

Body

IgnoreExistingSubscriberCheck

boolean

No

Body

UserId

integer

No

Body

StartType

string

No

Body

PassPeriodDays

integer

No

Body

PassCode

string

No

Body

Products

Array

No

Body

Product.ExternalProductId

string

No

Body

Product.ProductQuantity

integer

No

Body

SalesPerson.SalesPersonCode

string

No

Body

SalesPerson.VendorId

string

No

Body

OfferCode

string

No

Body

LegacyAccountNumber

string

No

Body

PresentationName

string

No

Body

CouponCode

string

No

Body

StartReason

string

No

Body

TransactionId

string

No

Body

AuthorizationCode

string

No

Body

LocationName

string

No

Body

LocationId

string

No

Body

InitialCredit.Amount

decimal

No

Body

InitialCredit.Currency

string

No

Body

InitialCredit.Reason

string

No

Body

InitialCredit.Description

string

No

Body

EbillEmail

string

No

Body

SalesTeamId

integer

No

Body

Subscriber.Email

string

Yes

Body

Subscriber.FirstName

string

No

Body

Subscriber.LastName

string

Yes

Body

Subscriber.Title

string

No

Body

Subscriber.CompanyName

string

No

Body

Subscriber.CompanyType

string

No

Body

Subscriber.Phone

string

No

Body

Subscriber.Country

string

No

Body

ApplePayPayload

object

No

Body

GooglePayPayload

object

No

Body

SendEmail

boolean

No

Body

OneTimeUseCode

string

No

Body

Currency

string

No

Body

EBillSignUp

boolean

No

Body

PianoInfo.TermId

string

No

Body

ProcessSync

boolean

No

Body

CreateTermsConsentEvent

boolean

No

Body

Subscriber

object

No

Body

RegistrationCount

integer

No

Body

PaymentAuthCaptured

boolean

No

Body

PaymentInformation.PaymentSource

string

No

Body

PaymentInformation.CreditCardType

string

No

Body

PaymentInformation.CreditCardLastFourDigits

string

No

Body

PaymentInformation.CreditCardExpiratonYear

string

No

Body

PaymentInformation.CreditCardExpirationMonth

string

No

Body

PaymentInformation.CardHolderName

string

No

Body

PaymentInformation.TransactionId

string

No

Body

PaymentInformation.Token

string

No

Newly added Parameters in /Purchases API 3.17.1.2

New parameters have been added under a new object PaymentInformation and another parameter PaymentAuthCaptured (boolean) has been added to handle already proccessed ApplePay and Credit Card payments.

Note: By default, PaymentAuthCaptured will be 'false' and no values are expected in the PaymentInformation object. This is the setting for standard existing flow (Payment is captured by Subscribe).

If the payment is already authorized and captured outside Subscribe, the value of PaymentAuthCaptured should be 'true'. When 'true', the parameters under the new object PaymentInformation must be passed. If not, the request will fail.

  • PaymentAuthCaptured - boolean

  • Under PaymentInformation

    • PaymentSource -

      • For ApplePay: ApplePay or ApplePayMPAN

      • For GooglePay: GooglePay or Google pay

      • For Credit Card: NULL

    • CreditCardType - any of the below values is expected:

      • For ApplePay: amex, americanexpress, american express, apple pay - american express, Discover, apple pay - discover, mastercard, master card, apple pay - mastercard, visa, or apple pay - visa

      • For GooglePay: amex, americanexpress, american express, discover, master card, mastercard, visa

      • For credit card individual: AMEX, VISA, MASTERCARD, or DISCOVER

    • CreditCardLastFourDigits - The last four digits of the Credit Card

    • CreditCardExpiratonYear - Credit Card expiration year

    • CreditCardExpirationMonth - Credit Card expiration month

    • CardHolderName - Credit Cardholder name

    • TransactionId - Payment Transaction Id

    • Token - Payment Token Id

    • PaymentTypeId (existing parameter)

      • For ApplePay - 34

      • For GooglePay - 37

      • For CreditCard - 1

200 Responses

{
  "Code": 200,
  "Errors": [],
  "Result":{
	"SubscriptionID": 0,
	"SubscriberID": 0,
	"EventId": 0,
	"AccountNumber": "string",
	"PaymentAuthorizationCode": "string",
	"RedirectUrl": "string",
	"CouponCode": "string",
	"EncryptedCouponCode": "string",
	"TwoSteps": false
},
  "SessionId": "string",
  "RequestId": "string"
}
200
{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Subscriptions01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The start date cannot be null and must be greater or equal than the current date.",
         "Code":"Subscriptions13",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find the specified country code.",
         "Code":"Subscriptions181",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The specified country does not allow sales.",
         "Code":"182",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The promotion does not exist or it is not available.",
         "Code":"Subscriptions46",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The plan does not exist or it is not available.",
         "Code":"Subscriptions29",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The selected offer does not allow any gift.",
         "Code":"Subscriptions113",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The selected offer requires to activate EzPay.",
         "Code":"Subscriptions79",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The selected offer does not have a base product which is not allowed.",
         "Code":"Subscriptions63",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The selected offer has multiple base products which is not allowed.",
         "Code":"Subscriptions62",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The product you are trying to subscribe to, belongs to a different newspaper. Subscription cannot be created.",
         "Code":"Subscriptions205",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The entered coupon could not be found.",
         "Code":"Subscriptions155",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The entered coupon was already used.",
         "Code":"Subscriptions155",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The payment type id entered is not allowed by promotion.",
         "Code":"Subscriptions61",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"A coupon code is required when paying by coupon.",
         "Code":"Subscriptions154",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Currency is required.",
         "Code":"Subscriptions239",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not perform active subscription check since there is not enough data. Please, check the delivery address, phone number, last name and products.",
         "Code":"Subscriptions100",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The plan does not exist or it is not available.",
         "Code":"Subscriptions29",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"The selected offer does not have a base product which is not allowed.",
         "Code":"Subscriptions63",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Failed to create Start.",
         "Code":"Subscriptions07",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not redeem the entered coupon code.",
         "Code":"Subscriptions158",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400/401/500 Error messages

{"error":"Authorization is missing."}	
{"error":"X-SourceSystem is missing."} 	
{"error":"Invalid PaymentInformation Data"} 	
{"error":"Invalid Source System."}
{"error":"Invalid authorization."} 		
{"error":"Something went wrong. Please try again later."}

Request Examples

{
    "StartDate": "2025-05-23T11:22:23.7265303",
    "ExpirationDate": "1970-01-01T01:01:01",
    "StartType": "Standard",
    "IgnoreExistingSubscriberCheck": false,
    "StartReason": "",
    "PaymentTypeId": 34,
    "TransactionId": null,
    "AuthorizationCode": null,
    "Currency": "USD",
    "Amount": {
        "AmountCharged": 10,
        "ActivationFee": 0,
        "TaxAmount": 0,
        "SubscriptionCost": 10,
        "ProcessingFeeAmount": 0,
        "ProcessingFeeTaxAmount": 0
    },
    "CreditCard": null,
    "BankAccount": null,
    "PayPalInfo": null,
    "ApplePayPayload": null,
    "InitialCredit": null,
    "GooglePayPayload": null,
    "SpreedlyInfo": null,
    "ExternalPaymentMethodId": null,
    "ExternalCustomerId": null,
    "ExternalToken": null,
    "CustomerRegistrationId": "auth0|66xyz",
    "EBillSignUp": false,
    "EBillEmail": null,
    "DeliveryAddress": null,
    "BillingAddress": {
        "Address": "1124 rue king",
        "AptUnit": "HUI",
        "ZipCode": "00000",
        "City": "No City",
        "State": "IN",
        "CountryCode": "US"
    },
    "ValidateAddress": false,
    "SendEmail": null,
    "LegacyAccountNumber": null,
    "Subscriber": {
        "Email": "mayankagarwal@gmail.com",
        "FirstName": "Mayank",
        "LastName": "Aggarwal",
        "Title": null,
        "CompanyName": null,
        "CompanyType": null,
        "Country": "US",
        "Phone": "3333333333"
    },
    "RegistrationCount": null,
    "OfferId": 5836,
    "OfferGroupId": 3277,
    "OfferCode": null,
    "PromotionCode": null,
    "OneTimeUseCode": null,
    "GiftId": 0,
    "ActivateEZPay": false,
    "Products": [
        {
            "ExternalProductId": "100060",
            "MerchantProductId": "100060",
            "ProductId": 100060,
            "ProductQuantity": 1
        }
    ],
    "PresentationName": "for_testing_99_Bk",
    "RecipientInformation": null,
    "UserId": -1,
    "SalesPerson": null,
    "LocationName": null,
    "LocationId": null,
    "CreateTermsConsentEvent": true,
    "PianoInfo": null,
    "ProcessSync": false,
    "PaymentAuthCaptured": true,
    "PaymentInformation": {
        "PaymentSource": "ApplePay",
        "CreditCardType": "Amex",
        "CreditCardLastFourDigits": "1580",
        "CreditCardExpirationYear": "2035",
        "CreditCardExpirationMonth": "08",
        "CardHolderName": "Mayank",
        "TransactionId": "5320250415052808898183",
        "Token": "10275962"
    }
{
    "StartDate": "2025-05-23T01:30:27.3303106",
    "ExpirationDate": "1970-01-01T01:01:01",
    "StartType": "Standard",
    "IgnoreExistingSubscriberCheck": false,
    "StartReason": "",
    "PaymentTypeId": 1,
    "TransactionId": null,
    "AuthorizationCode": null,
    "Currency": "USD",
    "Amount": {
        "AmountCharged": 10,
        "ActivationFee": 0,
        "TaxAmount": 0,
        "SubscriptionCost": 10,
        "ProcessingFeeAmount": 0,
        "ProcessingFeeTaxAmount": 0
    },
    "CreditCard": null,
    "BankAccount": null,
    "PayPalInfo": null,
    "ApplePayPayload": null,
    "InitialCredit": null,
    "GooglePayPayload": null,
    "SpreedlyInfo": null,
    "ExternalPaymentMethodId": "7472870235796290304603",
    "ExternalCustomerId": null,
    "ExternalToken": null,
    "CustomerRegistrationId": "auth0|68257xyz",
    "EBillSignUp": false,
    "EBillEmail": null,
    "DeliveryAddress": null,
    "BillingAddress": {
        "Address": "19222 Allegheny Rd",
        "AptUnit": "",
        "ZipCode": "92307",
        "City": "Apple Valley",
        "State": "CA",
        "CountryCode": "US"
    },
    "ValidateAddress": false,
    "SendEmail": null,
    "LegacyAccountNumber": null,
    "Subscriber": {
        "Email": "15may@gmail.com",
        "FirstName": "babita",
        "LastName": "gupta",
        "Title": null,
        "CompanyName": null,
        "CompanyType": null,
        "Country": "US",
        "Phone": "9873872372"
    },
    "RegistrationCount": null,
    "OfferId": 3296,
    "OfferGroupId": 721,
    "OfferCode": null,
    "PromotionCode": null,
    "OneTimeUseCode": null,
    "GiftId": 0,
    "ActivateEZPay": true,
    "Products": [
        {
            "ExternalProductId": "100060",
            "MerchantProductId": "100060",
            "ProductId": 100060,
            "ProductQuantity": 1
        }
    ],
    "PresentationName": "for_testing_test001_copy",
    "RecipientInformation": null,
    "UserId": -1,
    "SalesPerson": null,
    "LocationName": null,
    "LocationId": null,
    "CreateTermsConsentEvent": false,
    "PianoInfo": null,
    "ProcessSync": false,
    "PaymentAuthCaptured": true,
    "PaymentInformation": {
        "PaymentSource": "",
        "CreditCardType": "Amex",
        "CreditCardLastFourDigits": "1580",
        "CreditCardExpirationYear": "2035",
        "CreditCardExpirationMonth": "8",
        "CardHolderName": "CardHolderName",
        "TransactionId": "5320250415052808898183",
        "Token": "10275962"
    }
}

Below is a standard sample request to POST /Purchases API when the parameter 'PaymentAuthCaptured' is 'false'.

{
	"StartDate": "2022-07-13T08:13:51.7667144",
	"ExpirationDate": null,
	"StartType": "Standard",
	"IgnoreExistingSubscriberCheck": false,
	"StartReason": "",
	"PaymentTypeId": 1,
	"TransactionId": "",
	"AuthorizationCode": "",
	"Currency": "USD",
	"Amount": {
		"AmountCharged": 19.96,
		"ActivationFee": 0.0,
		"TaxAmount": 0.0,
		"SubscriptionCost": 19.96
	},
	"CreditCard": {
		"Type": "VISA",
		"Number": "411111******1111",
		"NumberFirstTwoDigits": "41",
		"NumberLastFourDigits": "1111",
		"ExpirationMonth": "12",
		"ExpirationYear": "2023",
		"SecurityCode": "",
		"OwnerName": "test"
	},
	"BankAccount": null,
	"PayPalInfo": null,
	"ApplePayPayload": null,
	"InitialCredit": null,
	"GooglePayPayload": null,
	"SpreedlyInfo": null,
	"ExternalPaymentMethodId": "2mh2vvr",
	"ExternalCustomerId": null,
	"ExternalToken": "2mh2vvr",
	"CustomerRegistrationId": "",
	"EBillSignUp": false,
	"EBillEmail": "",
	"DeliveryAddress": {
		"Address": "922 S PECOS WAY",
		"AptUnit": "2",
		"ZipCode": "80223",
		"City": "DENVER",
		"State": "CO",
		"CountryCode": "US"
	},
	"BillingAddress": {
		"Address": "922 S PECOS WAY",
		"AptUnit": "2",
		"ZipCode": "80223",
		"City": "DENVER",
		"State": "CO",
		"CountryCode": "US"
	},
	"ValidateAddress": true,
	"SendEmail": true,
	"LegacyAccountNumber": null,
	"Subscriber": {
		"Email": "sder@dvc.vbc",
		"FirstName": "test",
		"LastName": "rtes",
		"Title": "",
		"CompanyName": "",
		"CompanyType": "",
		"Country": "US",
		"Phone": "3333222254"
	},
	"RegistrationCount": null,
	"OfferId": 162,
	"OfferGroupId": 162,
	"OfferCode": "",
	"PromotionCode": "",
	"OneTimeUseCode": "",
	"GiftId": 0,
	"ActivateEZPay": true,
	"Products": [
		{
			"ExternalProductId": "100004",
			"MerchantProductId": "",
			"ProductId": 0,
			"ProductQuantity": 1
		}
	],
	"PresentationName": "",
	"RecipientInformation": {
		"FirstName": "",
		"LastName": "",
		"Email": "",
		"GiftMessage": ""
	},
	"UserId": 5244,
	"SalesPerson": {
		"SalesPersonCode": "AQA",
		"VendorId": "10"
	},
	"LocationName": "1",
	"LocationId": "1",
	"CreateTermsConsentEvent": false,
	"PianoInfo": null,
	"ProcessSync": false,
	"PaymentAuthCaptured": false,
    	"PaymentInformation": {
        	"PaymentSource": null,
        	"CreditCardType": null,
        	"CreditCardLastFourDigits": null,
        	"CreditCardExpirationYear": null,
        	"CreditCardExpirationMonth": null,
        	"CardHolderName": null,
        	"TransactionId": null,
        	"Token": null
        }
}
PreviousSubscribe APIsNextNewsletter Widget API

Last updated 2 days ago

Was this helpful?