Paylinks

patch

https://app.financekey.com/OData/Paylinks({key})

A paylink is a payment file that will be sent to a third party bank or service provider to initiate a set of payments. The paylink ensures the file integrity and the correct workflow is followed and actions taken prior to being sent and processed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

paylinkId

int32

The PaylinkId field in the Paylink table is an identity field of data type int, which serves as a unique identifier for each record in the table. This field is automatically generated and incremented by the database system, ensuring that each Paylink record has a distinct and permanent identification number. The PaylinkId is essential for tracking and managing individual records within the Paylink table and is frequently used as a primary key for data retrieval and manipulation. As an identity field, the PaylinkId provides a reliable and efficient way to uniquely identify and reference specific data in the Paylink table.

paylinkTemplateId

int32

The template that should be used to process the file.

comment

string | null

Miscellaneous notes and information for the entry or record.

approvalRequirementId

string | null

The ApprovalRequirementId field in the Paylink table is a nvarchar data type with a maximum length of 450 characters. This field is used to store the unique identification number for the approval requirement associated with a particular Paylink transaction. It is designed to help identify and track the specific approval requirement that has been assigned to the Paylink, providing crucial information for tracking and auditing purposes. The maximum length of 450 characters allows for longer identification numbers to be stored, ensuring the accuracy and completeness of data. This field is an essential component of the Paylink table, providing important details for effective record-keeping and analysis.

cashflowId

int32 | null

The CashflowId field in the Paylink table is a data type Integer which serves as a unique identifier for each cashflow transaction. This field is used to link cashflow records to their corresponding paylinks, allowing for easy tracking of financial information within the database. The CashflowId is essential for accurately organizing and analyzing cashflow data, making it a vital component in the Paylink table.

pde

boolean

The Pde field in the Paylink table is a bit data type that can store a boolean value representing either a true or false condition. This field is commonly used to indicate whether a payment has been successfully processed or not. A value of 1 signifies a successful transaction, while a value of 0 indicates a failed transaction. The Pde field plays a crucial role in accurately tracking and managing payment data within the Paylink table, providing a reliable indicator of payment status.

debitAccountId

int32 | null

paylinkStateMessage

string | null

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!