Payment Cycles

Description¶

The paymentCycles endpoint is used to get the list of Payment Cycles existing in the application.

Request¶

Endpoint¶

/ui/refdata/v1/paymentCycles

Method¶

 GET

Response¶

    {
        "id": 1,
        "recPymtFreqCode": "ONCE",
        "recPymtFreqDisplayText": "Once",
        "maxNumOfPaymentsAllowed": null,
        "pymtGtwyFrequencyText": "on-demand",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 2,
        "recPymtFreqCode": "WEEKLY",
        "recPymtFreqDisplayText": "Weekly",
        "maxNumOfPaymentsAllowed": 261,
        "pymtGtwyFrequencyText": "weekly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 3,
        "recPymtFreqCode": "BI_WEEKLY",
        "recPymtFreqDisplayText": "Bi-Weekly",
        "maxNumOfPaymentsAllowed": 130,
        "pymtGtwyFrequencyText": "bi-weekly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 4,
        "recPymtFreqCode": "QUAD_WEEKLY",
        "recPymtFreqDisplayText": "Quad-Weekly",
        "maxNumOfPaymentsAllowed": 65,
        "pymtGtwyFrequencyText": "quad-weekly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 5,
        "recPymtFreqCode": "MONTHLY",
        "recPymtFreqDisplayText": "Monthly",
        "maxNumOfPaymentsAllowed": 60,
        "pymtGtwyFrequencyText": "monthly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 6,
        "recPymtFreqCode": "SEMI_MONTHLY",
        "recPymtFreqDisplayText": "Semi-monthly",
        "maxNumOfPaymentsAllowed": 120,
        "pymtGtwyFrequencyText": "semi-monthly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 7,
        "recPymtFreqCode": "QUARTERLY",
        "recPymtFreqDisplayText": "Quarterly",
        "maxNumOfPaymentsAllowed": 20,
        "pymtGtwyFrequencyText": "quarterly",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 8,
        "recPymtFreqCode": "SEMI_ANNUALLY",
        "recPymtFreqDisplayText": "Semi-Annually",
        "maxNumOfPaymentsAllowed": 10,
        "pymtGtwyFrequencyText": "semi-annually",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    },
    {
        "id": 9,
        "recPymtFreqCode": "ANNUALLY",
        "recPymtFreqDisplayText": "Annually",
        "maxNumOfPaymentsAllowed": 5,
        "pymtGtwyFrequencyText": "annually",
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "createdDateTime": 1491251856000
    }

Tabular Format

PAYMENT CYCLE VALUE	PAYMENT CYCLE NAME
Annually	ANNUALLY
Bi-Weekly	BI_WEEKLY
Monthly	MONTHLY
Once	ONCE
Semi Annually	SEMI_ANNUALLY
Semi-Monthly	SEMI_MONTHLY
Quad-Weekly	QUAD_WEEKLY
Quarterly	QUARTERLY
Weekly	WEEKLY

Updated As Of Version: 1.7.0.12