Credit billing cycle

Create Client Billing Cycle

Changed on

This web service creates a billing cycle for a credit client

post/pws/pws_create_client_billing_cycle/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_create_client_billing_cycle/
  • Auth
    none declared

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

cycle_lengthinteger required

Cycle length which represent the duration of the cycle

cycle_unitstring required
<p>Cycle Unit is 1 character representing either day, month, or end of month.<ul><li>M-->Month</li><li>D-->Days</li><li>E-->End of Month</li></ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

cycle_dayinteger
<p>Cycle Day is the day of the month on which the cycle starts. </br> It is optional field. cycle_day is required if cycle_unit is M.</p>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "cycle_length": 1,
  "cycle_unit": "M",
  "cycle_day": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "config_id": "Credit Cycle Set Successfully for given account/card"
  }
}

Changes