PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Create a Template

post
https://portal-cert.shieldconex.com:4010/api/v1/templates

This endpoint allows to create Template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The system name of the template. Should not include spaces or special characters except underscores.

string
required

A reference identifier for the template.

boolean
required

Indicates if the template is published. Once set to true, the template is no longer editable."

int32

Version number of the template.

int32
required

The ID of the partner associated with this template.

string
required

The name of the partner associated with this template.

int32
required

The ID of the client associated with this template.

string
required

The name of the client associated with this template.

fieldTemplates
array of objects
fieldTemplates
string
enum

Specifies if the template type is user-defined or pre-defined.

Allowed:
string
enum

Access mode of the template, e.g., specific to certain domains.

Allowed:
string

Custom styles applied to the iFrame. Should be in CSS format.

string

File path to custom style file for the iFrame.

options.domains
array of strings

List of allowed domains for the template.

options.domains
boolean

Indicates if tokens generated by the template are irreversible.

string

The duration from the time of tokenization until the token can be detokenized. This is specified in ISO 8601 format.

date-time

The duration from the time of tokenization (not the time of activation) until the token can no longer be detokenized. This is specified in ISO 8601 format. Should be greater than the 'active from' setting. If not the token will be effectively irreversible.

Body Params

Template to be created.

string

The Template's name.

string

The Template's unique reference.

boolean

This property indicates if the Template is active or inactive. In the UI this is referred to as published and when set to true the template cannot be modified.

integer

The number of times that this resource has been updated.

partner
object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client
object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

fieldTemplates
array

Field Template list items

fieldTemplates
string
enum

The Template's type. TODO provide description

Allowed:
enum

The Template's access mode. TODO provide description

Allowed:
options
object
Responses

401

Unauthorized

403

Forbidden

Updated 3 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago