Routings

patch

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

A routing is a possible payment initiation channel within a country. It defines the identification mechanism for identifying an institute that holds an account, and in the case of IBAN, the account number too.

Path Params

key

string

required

Body Params

routingId

int32

RoutingId is an int data type primary key field in the Routing table. It is used to uniquely identify a particular routing record and link it to other related records.

code

string | null

The Code field in the Routing table is a 16 character nvarchar data type used to store alphanumeric values that represent specific routing information for a given item.

name

string | null

The Name of data type nvarchar field with a maximum length of 64 in the Routing table is a data field that holds up to 64 characters in the form of Unicode text. This field is used to store and manipulate data such as route information and addresses.

clearingSystemName

string | null

The ClearingSystemName field of data type nvarchar with a maximum length of 128 in the Routing table stores the name of the clearing system associated with a particular routing order.

countryId

string | null

The CountryId field is an nvarchar field in the Routing table that stores a character string representing the three-digit ISO alpha-3 code for a given country or region. It has a maximum length of 128 characters.

mask

string | null

The Mask field in the Routing table is an nvarchar field with a maximum length of 32 characters. This field is used to store a masking pattern which will be used in routing numbers or similar data.

maskLegend

string | null

MaskLegend is an nvarchar field in Routing table that contains alphanumeric information about the masks used to route a specific item or product. It is used to define or outline a particular path of the item or product in terms of its destination.

regexFormat

string | null

The RegexFormat field in the Routing table stores a regular expression (regex) which is used to validate phone numbers. The maximum length of 64 characters allows for complex validation.

example

string | null

The field Example of data type nvarchar with a maximum length of 32 in the table Routing is used to store alphanumeric data with variable length up to 32 characters. It can be used to store any information that is not numeric such as names, addresses, or words.

comment

string | null

Miscellaneous notes and information for the entry or record.

default

boolean

The Default field of type bit in the Routing table is a boolean field indicating whether the record data is being used as a default for a particular piece of routing. It allows for dynamic routing without manually changing multiple records each time. A value of 1 in this field means the record is default and 0 means it is overridden.

Response

200

Language

URL

Response

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