Generate Outgoing Payments API

This is an example of a response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
UIResult: {…},
Message: null,
IsSuccess: true,
ClientScript: null,
Serialized: '{"UIResult":{"NavigateToEntityPage":false,"Navigat…ientScript":null,"Serialized":null,"ErrorCode":0}'
}
ClientScript: null
ErrorCode: 0
IsSuccess: true
Message: null
Serialized: '{"UIResult":{
"NavigateToEntityPage":false,
"NavigateToEntityPageOnEdit":false,
"NavigateToEntityFormName":null,
"NavigateToEntityName":null,
"NavigateToEntityId":null,
"NavigateToEntityInsertDefaults":null,
"NavigateToUrl":null,
"DownloadFile":null,
"ReloadPage":false,
"Message":null,
"IsSuccess":false,
"Data":{
"isSuccess":null,
"errorMessage":null,
"errorCode":null,
"result":{
"outgoingPaymentRequestId":"80434a95-2a51-467f-b1cf-d573a267b35b",
"paymentReference":"REF0000911"
}
},
"NavigateToPageNo":null
},
Message:null,
IsSuccess:true,
ClientScript:null,
Serialized:null,
ErrorCode:0
}'



UIResult:
Data: {
isSuccess: null,
errorMessage: null,
errorCode: null,
result: {…}
}
DownloadFile: null
IsSuccess: false
Message: null
NavigateToEntityFormName: null
NavigateToEntityId: null
NavigateToEntityInsertDefaults: null
NavigateToEntityName: null
NavigateToEntityPage: false
NavigateToEntityPageOnEdit: false
NavigateToPageNo: null
NavigateToUrl: null
ReloadPage: false[[Prototype]]: Object[[Prototype]]: Object

Response description:

The following are the error messages that can be encountered during outgoing payments generation process:

This function verifies if an input value is null or empty.

Input parameters: value - The value that needs validation.

Output parameters:true/ false - The result of the validation.

This function validates the date.

Input parameters: dateString - The date string formatted like yyyy-MM-dd.

Output parameters: true/ false.

This function returns the Id of the bank from FTOS_PYMT_Bank entity.

Input parameters: bankCode - string - The code of the bank.

Output parameters: bankId - The Id of the bank, from FTOS_PYMT_Bank entity.

This function returns the Id of the outgoing payment from the FTOS_PYMT_OutgoingPayment entity

Input parameters: paymentNo - string - The number of the payment.

Output parameters: outgoingPaymentId - The Id of the outgoing payment, from FTOS_PYMT_OutgoingPayment entity.

This function returns the userId from the System User entity.

Input parameters: userName - string - The name of the user.

Output parameters: userId - The Id of the user, from the System User entity.

This function returns the reference number from FTOS_PYMT_OutgoingPayment entity.

Input parameters: outgoingPaymentId - string - The Id of the outgoing payment request.

Output parameters: referenceNo - The reference number from FTOS_PYMT_OutgoingPayment entity.

This function inserts a new outgoing payment request, based on the given object from the FTOS_PYMT_AddOutgoingPaymentRequest server automation script.

Input parameters: input – object – The object received from the FTOS_PYMT_AddOutgoingPaymentRequest server automation script. The object contains the details about:

• the payment request: paymentNo, paymentType, paymentAmount, paymentDueDate, creationDate, proposedBy, currency, scheduledDate, comments;

• the payment beneficiary: firstName, lastName - for individual persons, name - for legal persons and other category, uniqueID, beneficiaryType, beneficiaryCategory, iban;

• the payer: payerName, iban.

Output parameters:

• id - The Id of the newly inserted outgoing payment request.

• referenceNo - The reference number of the newly inserted outgoing payment request.

The addOutgoingPaymentRequest() function also uses some of the functions presented above and the getIdByAttrib() function, presented below.

This is a function from the FTOS_INS_Utils library. This function returns the Id of the given attribute.

Input parameters:

• entityName – string – The entity name.

• searchAttribute – string – The name of the attribute.

• searchValue – string – The value of the attribute .

Output parameters: The Id of the searched attribute. If there are no entries with the searched value, the output is null.

This function validates an option set value from an option set.

Input parameters:

• optionsetName - string - The name of the option set.

• optionsetItemValue - string - The value of the option set item.

Output parameters: true/ false.

This function returns an object result with one of the following responses: isSuccess, errorMessage, errorCode.

Input parameters:

• isSuccess - The success message.

• errorMessage - The error message.

• errorCode - The error code.

Output parameters: rez - An object containing the result.

This function validates the input object from the FTOS_PYMT_AddOutgoingPaymentRequest server automation script and uses some of the functions presented above.

Input parameters: input – object – The object received from the FTOS_PYMT_AddOutgoingPaymentRequest server automation script.

Output parameters: rez - An object containing the following details: {isSucces:true/false, errorMessage: “message error“, errorCode: “error code”}.