Build payments into your product with TPE virtual. Start integrating →
Logo

Forms

Manage the forms payers fill in at checkout.

List forms

GET/forms

Authorization

oauth2 forms:read
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:read

Query Parameters

page?integer
per_page?integer

At most 100.

search?string

Text to look for.

status?string

Filter by status.

sort_by?string

Field to sort by.

sort_dir?string

Sort direction.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.mytpe.app/api/ext/forms" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "trader_id": "b18507ce-7d55-4bf1-b12a-0ccca5b90936",
      "name": "string",
      "description": "string",
      "industry": "string",
      "status": "string",
      "is_template": true,
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "meta": {},
      "live_payment_links_count": 0,
      "sections": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
          "title": {},
          "description": {},
          "position": 0
        }
      ],
      "fields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
          "input_name": "string",
          "label": {},
          "help_text": {},
          "data_type": "string",
          "is_required": true,
          "validation_rules": "string",
          "options": [],
          "meta": {},
          "position": 0
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "current_page": 0,
    "last_page": 0,
    "per_page": 100,
    "total": 0,
    "from": 0,
    "to": 0,
    "path": "string",
    "links": []
  },
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Create a form

POST/forms

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mytpe.app/api/ext/forms" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name": "Your name"}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "trader_id": "b18507ce-7d55-4bf1-b12a-0ccca5b90936",
    "name": "string",
    "description": "string",
    "industry": "string",
    "status": "string",
    "is_template": true,
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "meta": {},
    "live_payment_links_count": 0,
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
        "title": {},
        "description": {},
        "position": 0
      }
    ],
    "fields": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
        "input_name": "string",
        "label": {},
        "help_text": {},
        "data_type": "string",
        "is_required": true,
        "validation_rules": "string",
        "options": [],
        "meta": {},
        "position": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Get a form

GET/forms/{form}

Authorization

oauth2 forms:read
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:read

Path Parameters

form*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.mytpe.app/api/ext/forms/your-form" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "trader_id": "b18507ce-7d55-4bf1-b12a-0ccca5b90936",
    "name": "string",
    "description": "string",
    "industry": "string",
    "status": "string",
    "is_template": true,
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "meta": {},
    "live_payment_links_count": 0,
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
        "title": {},
        "description": {},
        "position": 0
      }
    ],
    "fields": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
        "input_name": "string",
        "label": {},
        "help_text": {},
        "data_type": "string",
        "is_required": true,
        "validation_rules": "string",
        "options": [],
        "meta": {},
        "position": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Update a form

PATCH/forms/{form}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.mytpe.app/api/ext/forms/your-form" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name": "Your name"}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "trader_id": "b18507ce-7d55-4bf1-b12a-0ccca5b90936",
    "name": "string",
    "description": "string",
    "industry": "string",
    "status": "string",
    "is_template": true,
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "meta": {},
    "live_payment_links_count": 0,
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
        "title": {},
        "description": {},
        "position": 0
      }
    ],
    "fields": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
        "input_name": "string",
        "label": {},
        "help_text": {},
        "data_type": "string",
        "is_required": true,
        "validation_rules": "string",
        "options": [],
        "meta": {},
        "position": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Delete a form

DELETE/forms/{form}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.mytpe.app/api/ext/forms/your-form" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
Empty
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Add a field

POST/forms/{form}/fields

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mytpe.app/api/ext/forms/your-form/fields" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"input_name": "full_name", "data_type": "string"}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
    "input_name": "string",
    "label": {},
    "help_text": {},
    "data_type": "string",
    "is_required": true,
    "validation_rules": "string",
    "options": [],
    "meta": {},
    "position": 0
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Update a field

PATCH/forms/{form}/fields/{field}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string
field*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.mytpe.app/api/ext/forms/your-form/fields/your-field" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"form_section_id": "your-form-section-id"}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
    "input_name": "string",
    "label": {},
    "help_text": {},
    "data_type": "string",
    "is_required": true,
    "validation_rules": "string",
    "options": [],
    "meta": {},
    "position": 0
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Remove a field

DELETE/forms/{form}/fields/{field}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string
field*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.mytpe.app/api/ext/forms/your-form/fields/your-field" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
Empty
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Publish a form

POST/forms/{form}/publish

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mytpe.app/api/ext/forms/your-form/publish" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "trader_id": "b18507ce-7d55-4bf1-b12a-0ccca5b90936",
    "name": "string",
    "description": "string",
    "industry": "string",
    "status": "string",
    "is_template": true,
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "meta": {},
    "live_payment_links_count": 0,
    "sections": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
        "title": {},
        "description": {},
        "position": 0
      }
    ],
    "fields": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_section_id": "07d85c07-f4b8-4db9-a36d-c23a56ab21ba",
        "input_name": "string",
        "label": {},
        "help_text": {},
        "data_type": "string",
        "is_required": true,
        "validation_rules": "string",
        "options": [],
        "meta": {},
        "position": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Add a section

POST/forms/{form}/sections

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mytpe.app/api/ext/forms/your-form/sections" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"title": {"en": "Your text"}}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "title": {},
    "description": {},
    "position": 0
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Update a section

PATCH/forms/{form}/sections/{section}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string
section*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.mytpe.app/api/ext/forms/your-form/sections/your-section" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"title": {"en": "Your text"}}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "title": {},
    "description": {},
    "position": 0
  },
  "meta": {},
  "error": null
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Remove a section

DELETE/forms/{form}/sections/{section}

Authorization

oauth2 forms:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: forms:write

Path Parameters

form*string
section*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.mytpe.app/api/ext/forms/your-form/sections/your-section" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
Empty
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}
PostmanPostman collection

On this page

List formsCreate a formGet a formUpdate a formDelete a formAdd a fieldUpdate a fieldRemove a fieldPublish a formAdd a sectionUpdate a sectionRemove a section