Paylink States

Defines a the potential states for Paylink records.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
length between 1 and 32

The PaylinkStateId serves as the primary key field for the PaylinkState table. It is of data type nvarchar with a maximum length of 32, allowing for a wide range of unique values to be stored. This field is crucial in identifying and differentiating each state within the table, providing a key reference point for related data. The PaylinkStateId is an essential component in maintaining the integrity and organization of the data in the PaylinkState table.

string
required
length ≥ 1

The Description field is a nvarchar data type in the PaylinkState table, designed to provide a detailed explanation or summary of the information stored within the respective row. This field allows for the inclusion of up to 4000 characters, providing ample space to describe the nature, purpose, or other relevant details of the associated data. Its purpose is to provide context and clarity to the data stored in the PaylinkState table, making it easier to interpret and analyze for users or applications accessing the information. This field is especially valuable for complex data sets or when multiple tables are used, as it helps to establish a clear understanding of the relationships and meaning of the data.

string | null

Miscellaneous notes and information for the entry or record.

string | null

The BankState field in the PaylinkState table is a nvarchar data type with a maximum length of 32 characters. This field stores the state where the associated bank is located. It can contain abbreviations or full names for the state. This information is important for processing financial transactions and identifying the geographic location of the bank. It allows for easy organization and sorting of data for efficient banking operations.

string | null

The BadgeId field in the PaylinkState table is a nvarchar data type with a maximum length of 32 characters. This field serves as a unique identifier for a particular badge or credential associated with an individual or organization. It may contain alphanumeric characters and special symbols, allowing for a diverse range of badge IDs to be stored in the table. This field is crucial in maintaining accurate records and tracking the status of different badges within the PaylinkState system.

boolean

Permits paylink records in the state to be approved.

boolean

Permits paylink records in the state to be cancelled and processing halted.

boolean

Permits paylink records in the state to be reopened for processing.

boolean

Permits paylink records in the state to be sent to the 3rd party for payment execution.

boolean

Permits paylink records in the state to be submitted (for approval).

string
required

The maximum amount of time a paylink should remain in the state before being moved into another state.

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!