Billing And Collection Endpoints
There are cases when you need to access the product data or Insurance Product Factory functionalities in a way alternative to the one available as a user journey, in Innovation Studio. The solution allows you to make API calls regarding different product-related aspects. For interacting with defined products, the following endpoints are available:
-
FTOS_PYMT_StatementsGenerationAPI - Use this API to generate invoices for specific policies and installments. All the statement (invoice) generation business conditions will be applied when using the API as well. After calling the API, the invoice reference will be included in the response.
-
FTOS_PYMT_AddOutgoingPaymentRequest - Use this API to insert a new outgoing payment request, for different types of payments. After validating all the input keys, a new request is inserted, and the reference of the payment returned in the response.
-
FTOS_PYMT_GenerateMandate - Use this API to generate a new direct debit mandate for UK. The API handles the validation of the input keys as well as the logic for inserting the mandate, first into the FTOS_PYMT_DirectDebitMandateBuffer entity, and then, after processing the details, into the FTOS_PYMT_DirectDebitMandate entity.
Apart from the above mentioned endpoints, the following is the list of all the other endpoints available with the Billing and Collection solution:
| Name | Script | Description |
|---|---|---|
| ButtonActionPaymentReturn | ButtonActionPaymentReturn | |
| FTOS_AllocationInstallmentSearch | FTOS_AllocationInstallmentSearch | |
| FTOS_CreateTestPayUPayment | FTOS_CreateTestPayUPayment | |
| FTOS_INSP_GetAccountData_UniqueIdNo | FTOS_INSP_GetAccountData_UniqueIdNo | |
| FTOS_INSP_ManualAllocatePaymentRequestSearch | FTOS_INSP_ManualAllocatePaymentRequestSearch | This endpoint calls the FTOS_INSP_ManualAllocatePaymentRequestSearch script to search the outgoing payment requests to be allocated on an outgoing payment. |
| FTOS_INSP_ManualAllocationSearch | FTOS_INSP_ManualAllocationSearch | |
| FTOS_INSP_Payment_cancelPaymentReturn | FTOS_INSP_Payment_cancelPaymentReturn | |
| FTOS_INSP_Payment_declinePaymentReturn | FTOS_INSP_Payment_declinePaymentReturn | |
| FTOS_PayU_ImportBdx | FTOS_PayU_ImportBdx | |
| FTOS_PYMT_DeallocateOutgoingPayment | FTOS_PYMT_DeallocateOutgoingPayment | |
| FTOS_PYMT_DeallocateStatement | FTOS_PYMT_DeallocateStatement | |
| FTOS_PYMT_DeallocateStatementDetail | FTOS_PYMT_DeallocateStatementDetail | |
| FTOS_PYMT_DirectDebitMandate_cancelMandate | FTOS_PYMT_DirectDebitMandate_cancelMandate | |
| FTOS_PYMT_DirectDebitNotification_File_Validation | FTOS_PYMT_DirectDebitNotification_File_Validation | |
| FTOS_PYMT_GenerateStatementOnInstallment | FTOS_PYMT_GenerateStatementOnInstallment | |
| FTOS_PYMT_InsertStatementDueDate | FTOS_PYMT_InsertStatementDueDate | |
| FTOS_PYMT_ManualOutgoingPaymentAllocation | FTOS_PYMT_ManualOutgoingPaymentAllocation | |
| FTOS_PYMT_ManualPaymentAllocation | FTOS_PYMT_ManualPaymentAllocation | |
| FTOS_PYMT_OutgoingPayment_ApprovalAttributes | ||
| FTOS_PYMT_OutgoingPayment_ChangeBusinessStatusToApproved | FTOS_PYMT_OutgoingPayment_ChangeBusinessStatusToApproved | |
| FTOS_PYMT_OutgoingPayment_CompletePayerDetails | FTOS_PYMT_OutgoingPayment_CompletePayerDetails | |
| FTOS_PYMT_OutgoingPaymentAutomaticAllocation | FTOS_PYMT_OutgoingPaymentAutomaticAllocation | This endpoint uses the FTOS_PYMT_OutgoingPaymentAllocation_manual library in the manual process of outgoing payment allocation. |
| FTOS_PYMT_PaymentAutomaticAllocation | FTOS_PYMT_PaymentAutomaticAllocation | |
| FTOS_PYMT_Statement_EditStatus | FTOS_PYMT_Statement_EditStatus | |
| FTOS_PYMT_Statement_OnGrace_and_Unpaid_status | FTOS_PYMT_Statement_OnGrace_and_Unpaid_status | |
| FTOS_PYMT_StatementDetail_RemoveInstallment | FTOS_PYMT_StatementDetail_RemoveInstallment | |
| FTOS_PYMT_ValidateExternalRevenue | FTOS_PYMT_ValidateExternalRevenue | |
| FTOS_PYMT_validatePaymentReturn | FTOS_PYMT_validatePaymentReturn | |
| ProposePaymentReturnValidation | ProposePaymentReturnValidation |