Get Payment Method by Id
Introduction
This endpoint is used to retrieve the payment method information from the Naviga System based on the provided input parameter, PaymentMethodId.
Comparison
Note: For the time being, both the old and new endpoints are in the Billing API.
Billing API (OLD)
Billing API (NEW)
/Billing/{subscriptionId}/PaymentMethods/{paymentMethodId}
/Billing/PaymentMethods/{paymentMethodId}
FromUri, subscriptionId and paymentMethodId
/Billing/1/PaymentMethods/1
FromUri, paymentMethodId
/Billing/PaymentMethods/1
Get Payment Method by Id
GET /Billing/PaymentMethods/{paymentMethodId}
This endpoint is used to retrieve the payment method information from the Naviga System based on the provided input parameter, PaymentMethodId.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
JSON Web Token used for security purposes
To identify the consumer or the Source System
Media Group Code of the Tenant
Client Code of the Tenant
Request Body
Unique identifier of the payment method in Naviga System
{
"Code": 200,
"Errors": [],
"Result": {
"PaymentMethod": {
"HolderName": "Test Test",
"BankAccount": null,
"BillingAddress": {
"AddressId": 1859629,
"StreetAddress": "424 B ST APT 11",
"CityName": "MARYSVILLE",
"StateCode": "CA",
"ZipCode": "95901-5721",
"ProvinceOrTerritory": "CA",
"CountryCode": "US",
"HouseNumber": "424",
"StreetName": "B",
"StreetSuffix": "ST",
"DistrictName": "YUBA",
"FipsCode": "06115",
"UnitType": "APT",
"UnitNumber": "11",
"AddressName": "",
"PhoneNumber": "",
"BillingSystemAddressId": "1001634"
},
"CreditCard": {
"CardOwner": "Test Test",
"CreditCardType": 0,
"CreditCardNumber": "411111******1111",
"CreditCardExpirationMonth": "12",
"CreditCardExpirationYear": "26"
},
"PaymentMethodId": 789496,
"BillingSystemPaymentMethodId": "10193724",
"PaymentGatewayToken": null,
"PaymentGatewayCustomerId": null,
"PaymentMethodTypeId": 1
}
},
"SessionId": "27ec1745-8678-46ec-8fb7-fab743716383",
"RequestId": "test"
}
{
"Code":404,
"Errors":[
{
"Message":".",
"Code":"Billing_07",
"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."
}