curl --request POST \
--url http://localhost:3000/connect/v1/forms/forms/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": [
{
"label": "<string>",
"id": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>"
}
'import requests
url = "http://localhost:3000/connect/v1/forms/forms/"
payload = {
"fields": [
{
"label": "<string>",
"id": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": True,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"visibility": True,
"required": True,
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fields: [
{
label: '<string>',
id: '<string>',
label_en_us: '<string>',
label_en_uk: '<string>',
label_fr: '<string>',
label_nl: '<string>',
label_ind: '<string>',
key: '<string>',
required: true,
default_value: '<string>',
options: '<string>',
creator: '<string>',
updater: '<string>'
}
],
owner: '<string>',
id: '<string>',
field_config: [
{
label: '<string>',
key: '<string>',
id: '<string>',
visibility: true,
required: true,
creator: '<string>',
updater: '<string>'
}
],
creator: '<string>',
updater: '<string>'
})
};
fetch('http://localhost:3000/connect/v1/forms/forms/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/connect/v1/forms/forms/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
[
'label' => '<string>',
'id' => '<string>',
'label_en_us' => '<string>',
'label_en_uk' => '<string>',
'label_fr' => '<string>',
'label_nl' => '<string>',
'label_ind' => '<string>',
'key' => '<string>',
'required' => true,
'default_value' => '<string>',
'options' => '<string>',
'creator' => '<string>',
'updater' => '<string>'
]
],
'owner' => '<string>',
'id' => '<string>',
'field_config' => [
[
'label' => '<string>',
'key' => '<string>',
'id' => '<string>',
'visibility' => true,
'required' => true,
'creator' => '<string>',
'updater' => '<string>'
]
],
'creator' => '<string>',
'updater' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/connect/v1/forms/forms/"
payload := strings.NewReader("{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/connect/v1/forms/forms/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/connect/v1/forms/forms/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{
"label": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"products": [
{
"name": "<string>",
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>"
}Create Form Endpoint
The Create Form endpoint allows users to create a new form for transaction processing. Forms are used to add extra fields to store data while adding data to a resource. Different form types are available to specify the resources for the form. Field configurations can be added to customize the form’s behavior. The request should include details such as form ID, fields, field configuration, form type, and ownership information. The response provides the created form’s details, including form ID, associated products, fields, field configuration, update and creation timestamps, form type, and ownership information. This form can be used in transaction-related activities within the Connect system.
curl --request POST \
--url http://localhost:3000/connect/v1/forms/forms/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": [
{
"label": "<string>",
"id": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>"
}
'import requests
url = "http://localhost:3000/connect/v1/forms/forms/"
payload = {
"fields": [
{
"label": "<string>",
"id": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": True,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"visibility": True,
"required": True,
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fields: [
{
label: '<string>',
id: '<string>',
label_en_us: '<string>',
label_en_uk: '<string>',
label_fr: '<string>',
label_nl: '<string>',
label_ind: '<string>',
key: '<string>',
required: true,
default_value: '<string>',
options: '<string>',
creator: '<string>',
updater: '<string>'
}
],
owner: '<string>',
id: '<string>',
field_config: [
{
label: '<string>',
key: '<string>',
id: '<string>',
visibility: true,
required: true,
creator: '<string>',
updater: '<string>'
}
],
creator: '<string>',
updater: '<string>'
})
};
fetch('http://localhost:3000/connect/v1/forms/forms/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/connect/v1/forms/forms/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
[
'label' => '<string>',
'id' => '<string>',
'label_en_us' => '<string>',
'label_en_uk' => '<string>',
'label_fr' => '<string>',
'label_nl' => '<string>',
'label_ind' => '<string>',
'key' => '<string>',
'required' => true,
'default_value' => '<string>',
'options' => '<string>',
'creator' => '<string>',
'updater' => '<string>'
]
],
'owner' => '<string>',
'id' => '<string>',
'field_config' => [
[
'label' => '<string>',
'key' => '<string>',
'id' => '<string>',
'visibility' => true,
'required' => true,
'creator' => '<string>',
'updater' => '<string>'
]
],
'creator' => '<string>',
'updater' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/connect/v1/forms/forms/"
payload := strings.NewReader("{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/connect/v1/forms/forms/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/connect/v1/forms/forms/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\",\n \"label_en_us\": \"<string>\",\n \"label_en_uk\": \"<string>\",\n \"label_fr\": \"<string>\",\n \"label_nl\": \"<string>\",\n \"label_ind\": \"<string>\",\n \"key\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<string>\",\n \"options\": \"<string>\",\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"id\": \"<string>\",\n \"field_config\": [\n {\n \"label\": \"<string>\",\n \"key\": \"<string>\",\n \"id\": \"<string>\",\n \"visibility\": true,\n \"required\": true,\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n }\n ],\n \"creator\": \"<string>\",\n \"updater\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{
"label": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"products": [
{
"name": "<string>",
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>"
}Authorizations
Body
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
TRANSACTION, FARMER, PAYMENT, PRODUCT 