List of Payment Periods - GET

List of Payment Periods - GET API Endpoint
StoRegister - Login

List of Payment Periods API

The List of Payment Periods endpoint provides information about the available payment periods based on the master configuration of the account. The recurring tenures vary depending on the master value, with options such as Monthly, Quarterly, Semi-annually, and Annually for "MONTHLY" and Weekly, Bi-weekly, 4 Weeks, 8 Weeks, 13 Weeks, 26 Weeks, and 52 Weeks for "WEEKLY."

GET
/v1/common/payment-period
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve payment period information was successful.

  • status string

    Describes the status of the request to retrieve payment period information.

  • data object

    Array containing payment period information.

  • pagination object

    Details about pagination, including current page number, total number of pages, and overall count of items.

  • errors array

    Holds any error information if applicable.

Payment Period Option Details

Details about the payment period option.

array data

  • paymentPeriod string

    Code representing the payment period (e.g., "MONTHLY", "WEEKLY").

  • paymentPeriodValue string

    Description of the payment period (e.g., "Monthly", "Weekly").

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data": [
        {
            "paymentPeriod": "MONTHLY",
            "paymentPeriodValue": "Monthly",
        },
        {
            "paymentPeriod": "WEEKLY",
            "paymentPeriodValue": "Weekly",
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 2,
        "totalCount": 2
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation