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)
URL	/Billing/{subscriptionId}/PaymentMethods/{paymentMethodId}	/Billing/PaymentMethods/{paymentMethodId}
Method	GET	GET
Input Example	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.

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
PaymentMethodId*	Integer	Unique identifier of the payment method in Naviga System

200: OK Success Response

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

400: Bad Request Invalid Input

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

400: Bad Request Payment method not found

{
   "Code":404,
   "Errors":[
      {
         "Message":".",
         "Code":"Billing_07",
         "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."
}