Apply Payment

Introduction

This endpoint is used to perform a one-time payment in Circulation Systems (NCS Circ, CircPro, and Matrix).

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}/ApplyPayment

/Payment

Method

POST

Input Example

{
   "ExternalPaymentMethodId":"10200849",
   "CustomerId":null,
   "GiveTip":false,
   "TipAmount":0.0,
   "TotalAmount":9.99,
   "PaymentSelectedAmount":9.99,
   "CurrencyCode":null,
   "PaymentMethodType":0,
   "NewPaymentMethod":null,
   "TypeOfPayment":null,
   "ParentEventId":0,
   "GiveDonation":false,
   "DonationAmount":0.0,
   "Last4Digits":null,
   "AuthToken":"10200849",
   "AuthTokenPaymentMethodType":2,
   "SignUpToEzPay":false,
   "IsTipAutoRenew":null,
   "IsDonationAutoRenew":null,
   "ApplyToCredit":false,
   "ValidateMaxAmount":false,
   "InvoiceId":null,
   "CreateMapOnTheFly":false,
   "Notes":null,
   "Token":null,
   "RenewalTerm":"Month",
   "RenewalLength":"1",
   "RateCode":null,
   "RestartDate":null,
   "IgnoreFee":true,
   "TransactionId":null,
   "AccountInfo":{
      "SubscriptionId":102830,
      "SubscriberId":102311,
      "RegistrationId":0
   }
}

{
  "IgnoreFee": true,
  "DonationAmount": 0,
  "PaymentMethodId": 0,
  "SubscriptionId": 0,
  "TipAmount": 0,
  "TotalAmount": 0,
  "PaymentOptionAmount": 0,
  "TransactionId": "string",
  "ProcessingFeeAmount": 0,
  "ProcessingFeeTaxAmount": 0
}

Apply Payment

POST /Payment

This endpoint is used to perform a one-time payment in Circulation Systems.

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

TotalAmount*

Decimal

The total amount being paid (PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount).

If the PaymentType is Credit Card for NCS clients, an Activation Fee is charged to the TotalAmount.

Total Amount for NCS = PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount + ActivationFee

PaymentOptionAmount*

Decimal

The Payment Option Amount being paid.

IgnoreFee

Boolean

Indicate whether the Activation Fee should be ignored. Applicable for NCS clients.

TransactionId

String

Transaction ID created by the Payment Gateway when creating a new Payment Method. Applicable for Matrix clients.

ProcessingFeeAmount

Decimal

The Fee amount being paid. Applicable for NCS clients.

ProcessingFeeTaxAmount

Decimal

The Fee tax amount being paid. Applicable for NCS clients.

{
  "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":"The Total Amount is invalid.",
         "Code":"Payments_29",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Error getting newspaper configuration settings",
         "Code":"Payments_18",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "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":"SubscriberData not found.",
         "Code":"Payments_04",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "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":"Payment Method Type is not allowed.",
         "Code":"Payments_06",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "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":"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":"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":"Invalid subscription status",
         "Code":"Payments_19",
         "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":"Failed to create Payment event.",
         "Code":"Payments_02",
         "Type":{
            "Id":1,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Authorized funds has failed.",
         "Code":"Payments_09",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Failed when Processing Circ System.",
         "Code":"Payments_10",
         "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"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"Update Subscription Payment Method Id failed.",
         "Code":"Payments_21",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "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"
}

{
   "Code":400,
   "Errors":[
      {
         "Message":"The surcharge amounts only apply for Credit Card payment methods",
         "Code":"Payments_16",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "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."
}

PreviousMigration to Payments API NextEZPay Sign Up

Last updated 2 months ago