{
  "opencollection": "1.0.0",
  "info": {
    "name": "Payment Methods Management",
    "version": "1.1"
  },
  "items": [
    {
      "info": {
        "name": "payment methods",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a list of payment methods",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/paymentMethod",
            "headers": [
              {
                "name": "x-country-code",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "To retrieve methods of a specific type"
              },
              {
                "name": "customerId",
                "value": "",
                "type": "query",
                "description": "Mobile number or unique identifier of the customer"
              },
              {
                "name": "relatedParty.id",
                "value": "",
                "type": "query",
                "description": "To retrieve methods from a specific related party"
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "query",
                "description": "This is the transaction Id from the calling system. This is required if the relatedParty.id is CPG"
              },
              {
                "name": "description",
                "value": "",
                "type": "query",
                "description": "Other information, can be a merchant identifier .ie. merchantId etc."
              }
            ]
          },
          "docs": "Retrieve a list of payment methods"
        },
        {
          "info": {
            "name": "Update a payment method",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/paymentMethod/:paymentMethodId",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "paymentMethodId",
                "value": "",
                "type": "path",
                "description": "id of the payment method to update. Tells whether the customer billing type is 'Debit Order' or 'Credit Card' or 'Cash'. Currently 'Cash' is not supported."
              },
              {
                "name": "customerMsisdn",
                "value": "",
                "type": "query",
                "description": "Mobile number or unique identifier of the customer"
              },
              {
                "name": "providerId",
                "value": "",
                "type": "query",
                "description": "Impacted party to fullfil the service. This shows which system layer to be called to fulfil the request"
              },
              {
                "name": "billingAccountNumber",
                "value": "",
                "type": "query",
                "description": "Billing Account Number on which the update has to be done"
              },
              {
                "name": "idType",
                "value": "",
                "type": "query",
                "description": "identity type of the customer [RSAID,PASSPORT]"
              },
              {
                "name": "idNumber",
                "value": "",
                "type": "query",
                "description": "id number or the passport number of the customer"
              },
              {
                "name": "paymentDay",
                "value": "",
                "type": "query",
                "description": "Day of the month on which payment will be done against the customer bill. Possible values are between number 1 to 31"
              }
            ]
          },
          "docs": "Update a payment method"
        },
        {
          "info": {
            "name": "Delete a payment method",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/paymentMethod/:paymentMethodId",
            "headers": [
              {
                "name": "x-country-code",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "paymentMethodId",
                "value": "",
                "type": "path",
                "description": "id of the payment method to fetch"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "To retrieve methods of a specific type"
              },
              {
                "name": "customerMsisdn",
                "value": "",
                "type": "query",
                "description": "Mobile number or unique identifier of the customer"
              },
              {
                "name": "providerId",
                "value": "",
                "type": "query",
                "description": "Impacted party to fullfil the service. This shows which system layer to be called to fulfil the request"
              }
            ]
          },
          "docs": "Delete a payment method"
        }
      ]
    }
  ],
  "bundled": true
}