Update EZPay Info
Introduction
This endpoint is used to update the payment method for a recurring payment (EZPay) in Circulation Systems (NCS Circ, CircPro, 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.
The new endpoint fires the CHGCC/CHGACH event and assigns the payment method to the subscription.
URL
/Billing/{subscriptionId}/PaymentMethods
/Payment/EzPay
Method
PUT
PUT
Input Example
{
"PaymentMethod":{
"PaymentMethodId":0,
"ExternalPaymentMethodId":"10203992",
"PaymentMethodType":1,
"PaymentMethodTypeName":"CreditCard",
"PlatformSpecificTypeName":null,
"AccountHolder":"EARL HROZA",
"CreditCard":{
"CardType":2,
"CreditCardType":2,
"CreditCardNumber":"XXXXXXXXXXXX1111",
"ExpirationYear":2028,
"ExpirationMonth":2,
"CardSecurityCode":"",
"CardOwner":"john smith",
"LastFourDigits":"1111"
},
"BankAccount":null,
"PayPalInfo":null,
"OfflinePayment":null,
"BillingAddress":{
"AddressId":1700202,
"BillingSystemAddressId":null,
"PrimaryAddress":null,
"AlternateAddresses":null,
"CountryName":null,
"CityName":null,
"DistrictName":null,
"ProvinceOrTerritory":null,
"PhoneNumber":null,
"ZipCode":null,
"AddressName":null
},
"PaymentSource":null,
"TermsAndConditionsAccepted":true,
"ExternalToken":"10203992",
"ExternalCustomerId":null,
"IsDefault":false
},
"BillingAddressId":1700202,
"ValidateAddress":null,
"AccountInfo":{
"SubscriptionId":245316,
"SubscriberId":4784,
"RegistrationId":0
}
}{
"PaymentMethodId": 789496
"SubscriptionId": 238778
}Update EzPay Info
PUT /Payment/EzPay
This endpoint is used to update the 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
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
SubscriptionId*
Integer
Unique identifier of the Subscription in Naviga System.
PaymentMethodId*
Integer
Unique identifier of the payment method in Naviga System.
{
"Code": 200,
"Errors": [],
"Result": {
"EventId": 0,
"IsSuccess": true
},
"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":"Payment Method not found.",
"Code":"Payments_05",
"Type":{
"Id":2,
"Code":"Processing"
},
"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 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"
}{
"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": "X-SourceSystem is missing."
}{
"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":"The subscription is not on EzPay.",
"Code":"Payments_28",
"Type":{
"Id":0,
"Code":"Validation"
},
"ErrorSource":null
}
],
"Result":null,
"SessionId":"string",
"RequestId":"string"
}{
"Code":400,
"Errors":[
{
"Message":"Failed to create Payment event.",
"Code":"Payments_02",
"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"
}Last updated