Manage and Review Configured Taxes

The unique ID assigned to each tax which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every tax. This ULID is automatically created by our system and is used to uniquely identify and track each tax in our database.

The name is a clear label that quickly tells the person paying the payment what the tax is about. It's a customer-facing term used to identify and explain the taxes on various transaction-related documents and platforms. It's important for this name to be clear and descriptive, as it aids in ensuring transparency and understanding for the customer regarding the taxes applied to their purchase or service.

The tax amount value. The length includes the value, the decimal digit and the decimal value. The API accepts 2 digits like 50.53.

The tax value type.

Specify the unique two-letter country code ( e.g EG, SA or AE ) corresponding to the country where your tax was officially registered. This code is part of the standard international country codes set by the ISO .

It's a unique identifier assigned to each tax. It's primary role is to distinguish one tax from another, ensuring that each tax can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any tax endpoint with sending identify_by query parameter with value reference_id.

This value indicates whether the tax is active or not. This flag can be used to control the tax's availability in runtime environments or listings without deleting or removing the tax from records. A true value means the tax is active and functioning, while a false value implies that the tax is deactivated or not in use.

It provides clear, concise details about what the tax is for. It serves as an identifier or reference that helps in organizing, tracking, or categorizing taxes internally. This string will not be shown to customers.

The tax metadata model details. Metadata serves as a tool for keeping extra, organized details about a resource. For example, you can use it to store a user's preferences like prefered color, notes or any other data that aids in personalizing services, improving customer relations, or optimizing internal workflows. This information isn't utilized by Payiano – meaning it's not involved in authorizing or declining transactions and remains invisible to your users. Its value is entirely private for your internal use, and we ensure it remains confidential, not shared with any external parties.

The created datetime of the tax. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.