EZPay Sign Up

Introduction

This endpoint is used to create a payment method for a recurring payment (EZPay) in Circulation Systems (NCS Circ, CircPro, Saxo, and Matrix) and assign it to a subscription in Naviga System.

Comparison

Compared to the older model, the new input model requires just a few parameters, as explained in detail below.

Billing API (OLD)

Payments API (NEW)

URL

/Billing/Payments/{subscriptionId}/EzPaySignup

/Payment/EzPay

Method

POST

Input Example

{
   "ExternalPaymentMethodId":"mt8wvvpf",
   "CustomerId":null,
   "GiveTip":false,
   "TipAmount":0.0,
   "TotalAmount":0.0,
   "PaymentSelectedAmount":7.62,
   "TermsAndConditionsAccepted":true,
   "NewPaymentMethod":null,
   "ParentEventId":0,
   "GiveDonation":false,
   "DonationAmount":0.0,
   "Last4Digits":null,
   "AuthToken":null,
   "AuthTokenPaymentMethodType":0,
   "IsTipAutoRenew":null,
   "IsDonationAutoRenew":null,
   "ValidateMaxAmount":null,
   "Token":null,
   "RenewalTerm":"Week",
   "RenewalLength":"4",
   "RateCode":null,
   "AccountInfo":{
      "SubscriptionId":257175,
      "SubscriberId":91646,
      "RegistrationId":543
   }
}

NCS (DTI)

{ 
  "SubscriptionId": 2122613, 
  "PaymentMethodId": 3044934, 
  "RenewalTerm":"Week",
  "RenewalLength":"12",
  "PaymentOptionAmount":7.62,
  "TipAmount": 1.0,
}

Saxo (DSI)

{ 
  "SubscriptionId": 2122613, 
  "PaymentMethodId": 3044934, 
  "PaymentOptionAmount":7.62,
  "TipAmount": 1.0,
  "DonationAmount": 1.0,
}

CircPro

{ 
  "SubscriptionId": 2122613, 
  "PaymentMethodId": 3044934, 
  "RenewalTerm":"M",
  "RenewalLength":"1",
  "PaymentOptionAmount":7.62,
}

Matrix

{ 
  "SubscriptionId": 2122613, 
  "PaymentMethodId": 3044934, 
  "RenewalTerm":"1 MONTH",
  "PaymentOptionAmount":7.62,
  "TipAmount": 1.0,
}

POST /Payment/EzPay

This endpoint is used to create a payment method for a recurring payment (EZPay) in Circulation Systems and assign it to a subscription in Naviga System.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Headers

Name

Type

Description

Authorization*

String

JSON Web Token used for security purposes

X-SourceSystem*

String

To identify the consumer or the Source System

X-MediaGroupCode*

String

Media Group Code of the Tenant

X-ClientCode*

String

Client Code of the Tenant

X-PaperCode*

String

Paper Code of the Tenant

Request Body

Name

Type

Description

SubscriptionId*

Integer

Unique identifier of the Subscription in Naviga System.

PaymentMethodId*

Integer

Unique identifier of the payment method in Naviga System.

DonationAmount

Decimal

Donation amount.

TipAmount

Decimal

Tip amount.

PaymentOptionAmount

Decimal

EZPay Option Amount that will be paid.

RenewalTerm

String

Indicates the term to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.

RenewalLength

String

Indicates the length to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.

{
  "Code": 200,
  "Errors": [],
  "Result": {
    "EventId": 0
  },
  "SessionId": "string",
  "RequestId": "string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Payments_01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Subscription not found.",
         "Code":"Payments_03",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"The subscription is on EzPay already",
         "Code":"Payments_07",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Payment Method not found.",
         "Code":"Payments_05",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Not eligible for EzPay. Only Active subscriptions can sign up for EzPay",
         "Code":"Payments_08",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"The currency is empty in subscription.",
         "Code":"Payments_23",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Operation is not allowed because subscription has a permanent stop scheduled at a future date",
         "Code":"Payments_14",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"The subscription already made a payment over the last 24 hours",
         "Code":"Payments_13",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"The amount of retries to validate your payment session reached the maximum allowed",
         "Code":"Payments_26",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
    "error": "Authorization is missing."
}

{
    "error": "X-SourceSystem is missing."
}

{
    "error": "Invalid Source System."
}

{
    "error": "Invalid authorization."
}

{
    "error": "Something went wrong. Please try again later."
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"COMP subscription are not allowed to make payments",
         "Code":"Payments_27",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Create Event EzPay failed.",
         "Code":"Payments_15",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Update Subscription Data failed.",
         "Code":"Payments_20",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

PreviousApply Payment NextUpdate EZPay Info

Last updated 4 months ago