Forms

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.

POST

forms

curl --request POST \
  --url http://localhost:3000/connect/v1/forms/forms/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "fields": [
    {
      "id": "<string>",
      "label": "<string>",
      "label_en_us": "<string>",
      "label_en_uk": "<string>",
      "label_fr": "<string>",
      "label_nl": "<string>",
      "label_ind": "<string>",
      "type": "TEXT",
      "key": "<string>",
      "required": true,
      "default_value": "<string>",
      "options": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "field_config": [
    {
      "id": "<string>",
      "label": "<string>",
      "key": "<string>",
      "visibility": true,
      "required": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "form_type": "TRANSACTION",
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}'

{
  "id": "<string>",
  "products": [
    {
      "id": "<string>",
      "premiums": "<string>",
      "is_active": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "fields": [
    {
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "label_en_us": "<string>",
      "label_en_uk": "<string>",
      "label_fr": "<string>",
      "label_nl": "<string>",
      "label_ind": "<string>",
      "type": "TEXT",
      "key": "<string>",
      "required": true,
      "default_value": "<string>",
      "options": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "field_config": [
    {
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "key": "<string>",
      "visibility": true,
      "required": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "form_type": "TRANSACTION",
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}

Authorizations

Authorization

string

header

required

Body

application/json

fields

object[]

required

owner

string

required

string

field_config

object[]

form_type

enum<string>

Available options:

TRANSACTION,

FARMER,

PAYMENT,

PRODUCT

creator

string

updater

string

Response

201 - application/json

fields

object[]

required

owner

string

required

string

products

object[]

field_config

object[]

updated_on

string

created_on

string

form_type

enum<string>

Available options:

TRANSACTION,

FARMER,

PAYMENT,

PRODUCT

creator

string

updater

string

Retrieve Currencies Create a New Company

curl --request POST \
  --url http://localhost:3000/connect/v1/forms/forms/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "fields": [
    {
      "id": "<string>",
      "label": "<string>",
      "label_en_us": "<string>",
      "label_en_uk": "<string>",
      "label_fr": "<string>",
      "label_nl": "<string>",
      "label_ind": "<string>",
      "type": "TEXT",
      "key": "<string>",
      "required": true,
      "default_value": "<string>",
      "options": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "field_config": [
    {
      "id": "<string>",
      "label": "<string>",
      "key": "<string>",
      "visibility": true,
      "required": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "form_type": "TRANSACTION",
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}'

{
  "id": "<string>",
  "products": [
    {
      "id": "<string>",
      "premiums": "<string>",
      "is_active": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "fields": [
    {
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "label_en_us": "<string>",
      "label_en_uk": "<string>",
      "label_fr": "<string>",
      "label_nl": "<string>",
      "label_ind": "<string>",
      "type": "TEXT",
      "key": "<string>",
      "required": true,
      "default_value": "<string>",
      "options": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "field_config": [
    {
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "key": "<string>",
      "visibility": true,
      "required": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "form_type": "TRANSACTION",
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}

Trace Connect APIs

Authorizations

Body

Response