This endpoint is used to restart a stopped subscription in Circulation Systems (NCS Circ 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}/RestartPayment
/Payment/Restart
Method
POST
POST
Input Example
Restart
POST/Payment/Restart
This endpoint is used to restart a stopped subscription in Circulation Systems (NCS Circ and Matrix)
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 - Subscription’s Balance).
If the MG2 Control Setting "Restart.ApplyCreditBalance" has been turned off and the Subscription’s Balance is positive, then it won’t be deducted from the total. If Subscription’s Balance is negative (debt), it should always be in the math.
Take into consideration that each consumer application should do the math, so the setting should be consumed there too.
PaymentOptionAmount*
Decimal
The Restart Option Amount being paid.
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.
CreateRestartEvent
Boolean
Indicates whether to create the RESTART event.
For Saxo, CreateRestartEvent can be set to False if the client chooses to restart payment without restarting the subscription. Otherwise, this is optional.
RenewalLength
String
Indicates the Circulation System Provider's renewal length. Applicable for CircPro and NCS.
RenewalTerm
String
Indicates the Circulation System Provider's renewal term. Applicable for CircPro and NCS.
RestartDate
DateTime
Indicates the Subscription’s Restart Date. Currently, this is applicable for CircPro and Matrix.
{"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":"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":"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 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":"Update Subscription Data failed.","Code":"Payments_20","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."}
{"Code":400,"Errors":[ {"Message":"The payment cannot be processed. The subscription is not Stop.","Code":"Payments_22","Type":{"Id":1,"Code":"NotProcessingAllowed" },"ErrorSource":null } ],"Result":null,"SessionId":"string","RequestId":"string"}
{"Code":400,"Errors":[ {"Message":"Capture funds has failed.","Code":"Payments_11","Type":{"Id":2,"Code":"Processing" },"ErrorSource":null } ],"Result":null,"SessionId":"string","RequestId":"string"}
{"Code":400,"Errors":[ {"Message":"Restart date cannot be in the past","Code":"Payments_33","Type":{"Id":0,"Code":"Validation" },"ErrorSource":null } ],"Result":null,"SessionId":"string","RequestId":"string"}