Freedom Pay

Add client with product

POST

https://api.freedompay.kz/v5/partner/client/add

Request

Body Params application/json

request_id

string

required

Unique request identifier.

company

object

required

Client data object.

company_id

string

required

Identifier of the legal entity in the partner's system.

name

string

required

Name of the legal entity.

bin

string

required

Business Identification Number of the legal entity.

address

object

required

Registration address data object.

iban

string

optional

Account for mutual settlements.

description

string

optional

Description of the legal entity.

legal_type

string

optional

Type of the legal entity.

product

object

optional

Product parameters object. The parameter set depends on the connected product and is described in the Reference Guide.

Example

{
  "request_id": "string",
  "company": {
    "company_id": "string",
    "name": "string",
    "bin": "string",
    "address": {
      "country": "string",
      "postal_code": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string"
    },
    "iban": "string",
    "description": "string",
    "legal_type": "string"
  },
  "product": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/partner/client/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "company": {
        "company_id": "string",
        "name": "string",
        "bin": "string",
        "address": {
            "country": "string",
            "postal_code": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string"
        },
        "iban": "string",
        "description": "string",
        "legal_type": "string"
    },
    "product": {}
}'

Responses

🟢200Success

application/json

Body

status

string

optional

Displays the request status:

ok: Request completed successfully.

error: Request completed with an error.

request_status

string

optional

Displays the execution status of the request. See the reference documentation for details.

string <date-time>

optional

Date and time of the request (format: YYYY-MM-DDThh:mm:ss+hh:mm).

Example

{
  "status": "string",
  "request_status": "string",
  "dt": "2019-08-24T14:15:22Z"
}

Dictionaries

Request status