Add Tip

Introduction

This endpoint is used to handle the one-time and recurring payment transactions to add tips.

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}/AddTip	/Payment/Tip
Method	POST	POST
Input Example	{ "ExternalPaymentMethodId":"10200849", "CustomerId":null, "TipAmount":0.0, "CurrencyCode":null, "PaymentMethodType":0, "NewPaymentMethod":null, "TypeOfPayment":null, "ParentEventId":0, "Last4Digits":null, "AuthToken":"10200849", "AuthTokenPaymentMethodType":2, "IsTipAutoRenew":null, "ApplyToCredit":false, "ValidateMaxAmount":false, "InvoiceId":null, "CreateMapOnTheFly":false, "Notes":null, "Token":null, "RenewalTerm":"Month", "RenewalLength":"1", "RateCode":null, "RestartDate":null }	{ "PaymentMethodId":789771, "SubscriptionId":245316, "TipAmount":2.0, "TotalAmount":7.0, "IsTipAutoRenew":true, "ProcessingFeeAmount": 2.0, "ProcessingFeeTaxAmount": 3.0 }

---

Add Tip

POST /Payment

This endpoint is used to handle the one-time and recurring payment transactions to add tips.

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
TipAmount*	Decimal	Tip amount
ProcessingFeeAmount	Decimal	The Fee amount being paid. Applicable for NCS clients.
ProcessingFeeTaxAmount	Decimal	The Fee tax amount being paid. Applicable for NCS clients.
IsTipAutoRenew*	Boolean	Indicates whether the Tip amount should be auto-renewed.
TotalAmount*	Decimal	Total amount being paid (TipAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount)

200: OK Success Response

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

400: Bad Request Invalid Input

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

400: Bad Request Invalid Total Amount

{
   "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"
}

400: Bad Request Newspaper configuration settings error

{
   "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"
}

400: Bad Request Subscription not found

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

400: Bad Request Subscriber Data not found

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

400: Bad Request Payment Method not found

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

400: Bad Request Payment Method Type is not allowed

{
   "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"
}

400: Bad Request Comp Sub not allowed to make payments

{
   "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"
}

400: Bad Request Currency empty in subscription

{
   "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"
}

400: Bad Request Invalid Subscription Status

{
   "Code":400,
   "Errors":[
      {
         "Message":"Invalid subscription status",
         "Code":"Payments_19",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Payment was made in the last 24 hours

{
   "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"
}

400: Bad Request Failed to create Payment event

{
   "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"
}

400: Bad Request Authorized funds has failed

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

400: Bad Request Failed when Processing Circ System

{
   "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"
}

400: Bad Request Update Subscription Data failed

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

400: Bad Request Update Subscription PaymentMethodId failed

{
   "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"
}

400: Bad Request Exceeded session validation attempts

{
   "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"
}

400: Bad Request Surcharge for incorrect payment method

{
   "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"
}

400: Bad Request Authorization is missing

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

400: Bad Request X-SourceSystem is missing

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

401: Unauthorized Invalid Source System

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

401: Unauthorized Invalid authorization

{
    "error": "Invalid authorization."
}

500: Internal Server Error Internal Server Error

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

400: Bad Request Payment was modified in the last 24 hours

{
   "Code":400,
   "Errors":[
      {
         "Message":"The payment method was already modified over the last 24 hours.",
         "Code":"Payments_32",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request To set up an auto renew tip, the subscription has to be on EzPay.

{
   "Code":400,
   "Errors":[
      {
         "Message":"To set up an auto renew tip the subscription has to be on EzPay.",
         "Code":"Payments_31",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Tip amount exceeds the maximum allowed

{
   "Code":400,
   "Errors":[
      {
         "Message":"The tip amount exceeds the maximum allowed.",
         "Code":"Payments_17",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Capture funds has failed

{
   "Code":400,
   "Errors":[
      {
         "Message":"Capture funds has failed.",
         "Code":"Payments_11",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Update transaction failed

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