Templating
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseSuccessful
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseIndicates whether the template is active or not.
Bad Request
Unauthorized
Forbidden
Internal Server Error
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
The id parameter in the GET API uniquely identifies a checkout template, allowing you to retrieve detailed information about a specific template by providing its associated identifier.
Successful
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseIndicates whether the template is active or not.
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
The id parameter in the GET API uniquely identifies a checkout template, allowing you to retrieve detailed information about a specific template by providing its associated identifier.
Success. Template was successfully deleted.
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No content
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
The id parameter in the GET API uniquely identifies a checkout template, allowing you to retrieve detailed information about a specific template by providing its associated identifier.
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseSuccessful
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseIndicates whether the template is active or not.
Bad Request
Unauthorized
Forbidden
Internal Server Error
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
Filter templates using RSQL syntax. Combine expressions with ; (AND) or , (OR).
Filterable fields:
| Field | Type | Operators |
|---|---|---|
name | string | == != =in= =out= =regex= =contains= |
created_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
updated_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
entity_id | string | == != =in= =out= =regex= |
Examples:
name==MyTemplate;entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9name==TemplateName
The ordering sequence of the selected templates If not selected then Descending order is the default order.
A filter query in RSQL format to retrieve templates based on page number. If not selected then a default pageNumber is 1.
A filter query in RSQL format to retrieve templates based on page size. If not selected then a default pageSize is 50
Successful
Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
Indicates whether billing address is same as shipping address or not.
trueIndicates the order of addresses in which the merchant wants to collect the information from the customer.
falseBad Request
Unauthorized
Forbidden
Internal Server Error
HTTP Basic authentication using entity credentials (username:password encoded in Base64).
Filter templates using RSQL syntax. Combine expressions with ; (AND) or , (OR).
Filterable fields:
| Field | Type | Operators |
|---|---|---|
name | string | == != =in= =out= =regex= =contains= |
created_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
updated_at | date | == != =in= =out= =gt= =ge= =lt= =le= |
entity_id | string | == != =in= =out= =regex= |
Examples:
name==MyTemplate;entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9name==TemplateName
Successful
Count
Bad Request
Unauthorized
Forbidden
Internal Server Error
Last updated
Was this helpful?