diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 538aa0238..fb03182f2 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -24827,20 +24827,20 @@ No Request Body:
Ability to be able to transfer monetary funds from one account to another.
-Note: At present only savings account to savings account and savings account to Loan account.
+Standing instructions (or standing orders) refer to instructions a bank account holder ("the payer") gives to his or her bank to pay a set amount at regular intervals to another's ("the payee's") account.
+Note: At present only savings account to savings account and savings account to Loan account transfers are permitted.
Mandatory Parameters |
| name |
| Standing Instruction Name. |
| A name for this Standing Instruction |
| fromOfficeId |
| The id of the office/branch from which the transfer is made. |
| fromClientId |
| The id of the client from which the transfer is made. |
| The id of the client (payer) who makes the transfer |
| fromAccountType |
| The type of account from which the transfer is made. 1=Loan Account, 2=Savings Account |
| The id of the office/branch to which the transfer is made. |
| toClientId |
| The id of the client to which the transfer is made. |
| The id of the client (payee), to whose account the transfer is made. |
| toAccountType |
| The type of account to which the transfer is made. 1=Loan Account, 2=Savings Account |
| toAccountId |
| The id of the account to which the transfer is made. The accouont must be active and must have the same currency as that of the selected fromAccountId. |
| The id of the account to which the transfer is made. The account must be active and must be in the same currency as that of the selected fromAccountId. |
| priority |
| The priority of instruction while executiing instructions. 1= URGENT,2 = HIGH, 3 = MEDIUM, 4 = LOW |
| The priority of instruction while executing instructions. 1= URGENT,2 = HIGH, 3 = MEDIUM, 4 = LOW |
| transferType |
| The type of account transfer from which account to which. 1=Account Transfer(savings to savings), 2=Loan Repayment |
| Identifies the source and destination account types. 1=Account Transfer(savings to savings), 2=Loan Repayment |
| instructionType |
| The Standing instruction amount for transfer type while execution of standing instruction. 1. FIXED, 2.DUES |
| Determines the amount to be transferred while executing a standing instruction. 1. FIXED, 2.DUES |
| status |
| The Standing instruction state. 1. Active, 2.Disabled,3.deleted |
| The Standing instruction state. 1. Active, 2.Disabled, 3.Deleted |
| recurrenceType |
| The Standing instruction schedule type for execution.. 1. Periodic, 2.As per dues |
| Determines the recurrence of this standing instruction, can be either 1. Periodic or 2.As per dues |
| validFrom |
| The Standing instruction's Start date. |
Optional Parameters |
| amount |
| Transfer amount while running the instruction. must be provided if instructionType is fixed |
| Transfer amount while running the instruction. must be provided if the selected instructionType is fixed |
| validTill |
| The Standing instruction's Start date. |
| The Standing instruction's end date. |
| recurrenceFrequency |
| The periodic frequency of standing instruction.must be provided if recurrenceType is Periodic. 0=days,1= weeks,2=months,3=years |
| The recurrence frequency of a Standing instruction's execution. Must be provided if the recurrenceType is Periodic. 0 = days, 1 = weekly, 2 = monthly, 3 = yearly |
| recurrenceInterval |
| The periodic frequency interval of standing instruction.must be provided if recurrenceType is Periodic |
| The recurrence interval of a standing instruction execution, determines the recurrence schedule when combined with recurrenceFrequency. Must be provided if the recurrenceType is periodic |
| recurrenceOnMonthDay |
| The Month and Day of periodic frequency.must be provided if recurrenceFrequency is months or years |
| The Month and Day of recurrence. Must be provided if the recurrenceFrequency is monthly or yearly |