PayTo Agreement Types

depending on your use case, there are various types of payto agreement and various frequencies available when creating an agreement with the create a payment agreement docid\ isybadzfpyzmkydo cy8n endpoint you'll need to pass a valid agreement type and frequency frequency frequency determines how frequently payments can be initiated against the agreement if creating an agreement for a single payment, adhoc is suggested code name description adho adhoc event takes place on request or as necessary dail daily event takes place every day frtn fortnightly event takes place every two weeks inda intraday event takes place several times a day mian semiannual event takes place every six months or two times a year mnth monthly event takes place every month or once a month qurt quarterly event takes place every three months or four times a year week weekly event takes place once a week year annual event takes place every year or once a year agreement type the agreement type you'll use is dependent on your use case, and will affect the validation for any payment initiations made against the agreement code name description fixe fixed payment amount is fixed usgb usagebased payment amount is based on usage examples include phone and electricity billing vari variable payment amount is variable variable agreements can be used for use cases where there is a need to increase or decrease the amount paid without requiring changes to the agreement amount and maximum amount payto agreements can contain two amount fields; amount and maximumamount amount is a fixed amount field; if you provide only the amount field in a payment agreement, you can only debit that amount if you specify only the maximumamount field, you can debit any amount between $0 01 and the set maximum if both amount and maximumamount fields are included, you can debit any amount not less than the amount and not greater than the maximumamount agreement type + amount the create agreement endpoint validates amount and maxamount differently, depending on the agreement type used for variable or usage based agreements, it is recommended to populate the maxamount where practical agreementtype amount maximumamount rules fixe valid numeric value n/a if fixed, only amount should have values maxamount should not be present usgb valid numeric value valid numeric value if usage based, maaamount is recommended however, amount and maxamount are optional if both amount and maxamount are present, amount should be less than maxamount vari valid numeric value valid numeric value if variable, maxamount is recommended however, amount and maxamount are optional if both amount and maxamount are present, amount should be less than maxamount agreement purpose the agreement type identifies the purpose of the payment and is dependent on your use case code description mort mortgage payments util utility payments loan loan payments depd dependant support payments gamp gambling payments retl retail payments sala salary payments pers personal payment govt government payments pens pension payments taxs tax payments othr other service payments