API Reference

Paylink Templates

patch
https://app.financekey.com/OData/PaylinkTemplates()

A Paylink Template defines the workflow, permissions and final destination for paylink files. Paylink Templates are assigned to Paylinks as they are uploaded into the system.

Path Params
string
required
Body Params
int32

The PaylinkTemplateId is an identity field within the PaylinkTemplate table that stores a unique identifier for each template. This data type is represented by an integer and is automatically incremented for each new template added to the table. This field serves as the primary key for the table, making it a crucial component for the organization and retrieval of data within the PaylinkTemplate. It ensures each template is easily distinguished and identified within the table, providing a systematic way to manage and track templates. This field is essential for maintaining the integrity and consistency of the PaylinkTemplate table, making it a crucial aspect of the overall database structure.

string | null

Description and purpose of the paylink template.

string | null

Miscellaneous notes and information for the entry or record.

int32 | null

The integration to be used to transmit the paylink files to the bank once submitted and fully approved.

int32 | null

The account which will be debited when fulfilling the payments within the paylink file.

boolean

When consolidated, the cashflows with paylink files will reported as a single net amount. If not consolidated, cashflows will be generated for each transaction, and it is expected that there will be matching and equivalent transactions reported by the bank on account transaction.

boolean

When checked, it will not be possible to view the return files. This is used in cases where the bank is sending back status files that contain sensitive information.

string | null

When specified, it is mandators that the file contains the specified string pattern.

string | null

Specifies the approvals required between a file being submitted and sent to the bank.

boolean

When checked, the submitter is required to upload a justification document prior to submitting the file.

boolean

Allows Submitters to also perform a step of the Approval.

int32 | null

The access group that can perform the upload. When set, it is not necessary to individuals with upload access.

string
required
length between 1 and 450

The PaylinkTemplate table contains a field called PaylinkCategoryId, which is of data type nvarchar with a maximum length of 450 characters. This field stores the identifying category for a specific paylink, which is a unique URL used for making payments. This category helps to organize and differentiate the paylinks within the table. As a string data type, nvarchar allows for the storage of both alphanumeric and special characters. With a maximum length of 450, this field can accommodate longer category names, allowing for better categorization and organization of paylinks within the PaylinkTemplate table.

Response
200

OK

Updated almost 2 years ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated almost 2 years ago