API docs by Redocly

TeslaPay Api Specification (2.0.2)

Download OpenAPI specification:

Core API V2

Api version 1 here

Changelog

You can follow and get to know the latest API changes and improvements here.

LHS Brackets filtering support

For example, GET /clients/?filter=age[gte]21 or (email[eq]"a@a.com" and CreateDate[eq]2019-01-31) would find all the items where the age is greater than or equals to 21 or email equals a@a.com and CreateDate equals 31 Jan 2019. Default the logical operator and. LIKE operator with SQL pattern supported, but ESCAPE option NOT supported. For available filter fields, and their types see endpoint description

Notations

Operator Bracket Notation
N/A [range]
N/A [like]
= [eq]
!= [ne]
> [gt]
>= [gte]
< [lt]
<= [lte]
and and
or or

Datatypes

Type format
string Value in double quotes. ex: email[like]"%.com"
date Date as defined by yyyy-mm-dd
number Integer number with no thousand delimiters

Response codes

HTTP Code Description
200 Request completed successfully
400 Invalid request. Show message box with "OK" button. Message text from response field failure_message and concatenate with text "Error: detail.error_id". Title should be filled from detail.title
408 Execution timeout. Retry same request later
Other Show message box with "OK" button. Message text: "We apologize for any inconveniences caused, please contact TeslaPay Customer Support via 'Messaging' section. Error code: detail.error_id ". Title should be filled from detail.title

Client Api V2

Client operations. Work in progress (WIP)

Create client

This operation create client.

Authorizations:
basicMab
header Parameters
x-request-id
required
string <= 64 characters

Request id. Will act as an idempotency key

x-partner-code
required
string <= 255 characters
Deprecated

The unique identifier of the external system

Request Body schema: application/json
required

Create client

external_reference
required
string <= 64 characters

External reference of the client in Regtek system. It is used to identify the client in the external system.

client_type
required
string
Enum: "PERSON" "COMPANY"

Client type

object (PersonV2Model)

Person attributes

object (CompanyV2Model)

Legal entity information

license - License scan share_register - Shareholders Register director_register - Director Register trade_register - Extract from the Trade Register

Responses

Request samples

Content type
application/json
{
  • "external_reference": "AZ9876543210",
  • "client_type": "PERSON",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "external_reference": "AZ1234567890",
  • "client_type": "PERSON",
  • "person": {
    }
}

List clients

This operation retrieves list of the partner clients.

Filter fields
Field Type
email string
contact_mobile_number string
external_id string

Filter example with limit/offset:

GET /v1/clients/?limit=300&offset=0&filter=contact_mobile_number[eq]"%2B37129207562";create_date[gte]2019-07-13;create_date[lte]2019-07-16

Authorizations:
basicMab
query Parameters
offset
integer <int64> (offsetType) [ 0 .. 2147483647 ]

The number of items to skip before starting to collect the result set.

limit
integer <int64> (limitType) [ 1 .. 100 ]

The numbers of items to return.

filter
string

LHS filter expression.

header Parameters
x-partner-code
required
string <= 255 characters
Deprecated

The unique identifier of the external system

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update client

This operation partially updates client info. Only one of person/company is required, matching client_type. Properties omitted from that nested object are left unchanged — see PersonV2UpdateModel/CompanyV2UpdateModel.

Authorizations:
basicMab
path Parameters
clientId
required
string <= 64 characters

The unique identifier of the client

header Parameters
x-request-id
required
string <= 64 characters

Request id. Will act as an idempotency key

x-partner-code
required
string <= 255 characters
Deprecated

The unique identifier of the external system

Request Body schema: application/json
required

Update client

client_type
required
string
Enum: "PERSON" "COMPANY"

Client type

object (PersonV2UpdateModel)

Partial update of person attributes. Mirrors PersonV2Model, minus identity/read-only fields that cannot be changed after creation (id, status, kind, external_reference).

This is a partial update: only properties present in the request body are changed. A property that is omitted leaves the current value untouched; a property sent with an explicit null clears it (where nullable). Sending an empty object {} is a no-op.

object (CompanyV2UpdateModel)

Partial update of company (legal entity) attributes. Mirrors CompanyV2Model, minus identity/read-only fields that cannot be changed after creation (id, status, kind, external_reference, site_info).

This is a partial update: only properties present in the request body are changed. A property that is omitted leaves the current value untouched; a property sent with an explicit null clears it (where nullable). Sending an empty object {} is a no-op.

license - License scan share_register - Shareholders Register director_register - Director Register trade_register - Extract from the Trade Register

Responses

Request samples

Content type
application/json
{
  • "client_type": "PERSON",
  • "person": {
    },
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "client_type": "PERSON",
  • "person": {
    },
  • "company": {
    }
}

Services Api V2

List of allowed NACE codes

Get available NACE codes list

Authorizations:
basicMab

Responses

Response samples

Content type
application/json
[
  • {
    }
]