Customer

Working with customers you have the following features:

• Create customer with first account

• Get customer's accounts

• List customers per counterparty

• Update a customer

• Get details for a single digital account

Create customer with first account

Before a customer is created please ensure "Bank Authorization" contains a corresponding secret for it.

The same secret is used for all accounts of the customer.

To create a customer and their first account you should use the following request:

Create customer

post

Create customer

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

asset_codestringRequired

required Asset's code of e-money currency

asset_issuerstringRequired

required Address in stellar which issues token

balance_allowednumberOptional

optional default 0, customer's allowed balance

balance_asset_codestringOptional

optional Balance's asset code

balance_asset_issuerstringOptional

optional Balance's asset issuers

branch_guidstringOptional

optional Branch's GUID

ibanstringOptional

optional IBAN

is_disabledbooleanOptional

If you need to disable an employee you should make this parameter true, default it is false

kyc_levelintegerOptional

optional default 0, customer's level of verification(KYC)

loginstringOptional

Login unique user name phone, email or other

namestringOptional

optional Customer's name

paternal_namestringOptional

optional Customer's paternal name

phone_numberstringOptional

optional Customer's phone number

segmentstringOptional

optional Customer's segment: Public Liability (PL) or Professional Indemnity (PI)

statusstringOptional

optional Customer's status

surnamestringOptional

optional Customer's surname

Responses

200

OK

application/json

400

json with error msg

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/customers HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "asset_code": "text",
  "asset_issuer": "text",
  "balance_allowed": 1,
  "balance_asset_code": "text",
  "balance_asset_issuer": "text",
  "branch_guid": "text",
  "iban": "text",
  "is_disabled": true,
  "kyc_level": 1,
  "login": "text",
  "name": "text",
  "paternal_name": "text",
  "phone_number": "text",
  "segment": "text",
  "status": "text",
  "surname": "text"
}

{
  "activated": true,
  "assets": [
    {
      "activated": true,
      "balance": 1,
      "code": "text",
      "minor_unit": 1,
      "name": "text",
      "platform": "text",
      "stellar_code": "text",
      "stellar_issuer": "text"
    }
  ],
  "assets_total": 1,
  "blocked": true,
  "customer_guid": "text",
  "guid": "text",
  "iban": "text",
  "name": "text",
  "platform": "text",
  "registered": true,
  "type": "text",
  "wallet_account_guid": "text"
}

For asset_code and asset_issuer please consult Common requirements.

Response example:

{
    "customer_guid": "e13e81c4-056b-4e84-96ba-d9d9daba3557",         // customer's identifier
    "platform": "",
    "type": "5e3f4309-c152-48b3-8091-046708694f90",
    "guid": "51599e25-83b4-11ee-aa27-ba6fe7e5a0e5",                  // account GUID
    "wallet_account_guid": "51599e25-83b4-11ee-aa27-ba6fe7e5a0e5",   // account GUID
    "name": "customer",
    "assets_total": 1,
    "assets": [
        {
            "activated": true,
            "balance": 0,                                            // balance
            "platform": "",
            "code": "UAH",                                           // asset code
            "name": "Ukraine Hryvnia",
            "stellar_code": "eUAH",                                  // asset stellar code
            "stellar_issuer": "GDQQY7WXGK5JZJQHLY7GMNZOCJ2QVG3ZNHDT4WYCNJU6ZG53RVXZPN2E",
            "minor_unit": 2                                          // how many decimal places does this asset contain
        }
    ],
    "activated": true,
    "registered": false,
    "blocked": false,
    "iban": "LT966008050860332937"
}

Note: an account has one identificator assigned.

Account has status attributes:

• activated

• registered

• blocked

The attributes are not used currently.

Get customer's accounts

To show customer's accounts, you should use this endpoint:

Customer's accounts

get

Get customer's accounts on behalf of employee

Path parameters

counterparty_guidstringRequired

Counterparty GUID

customer_guidstringRequired

Customer GUID

Query parameters

ibanstringOptional

iban (string)

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/customers/{customer_guid}/accounts HTTP/1.1
Host: your_host
Accept: */*

{
  "accounts": [
    {
      "activated": true,
      "assets": [
        {
          "activated": true,
          "balance": 1,
          "code": "text",
          "minor_unit": 1,
          "name": "text",
          "platform": "text",
          "stellar_code": "text",
          "stellar_issuer": "text"
        }
      ],
      "assets_total": 1,
      "blocked": true,
      "guid": "text",
      "iban": "text",
      "name": "text",
      "platform": "text",
      "registered": true,
      "type": "text",
      "wallet_account_guid": "text"
    }
  ],
  "total": 1
}

Response example

{
    "accounts": [
        {
            "platform": "",
            "type": "c77ed677-1d4d-4eac-993c-724d78cc3028",
            "guid": "f0ce3e50-2239-11ee-a188-62e161fdf271",
            "name": "customer",
            "assets_total": 1,
            "assets": [
                {
                    "activated": true,
                    "balance": 0,
                    "platform": "",
                    "code": "UAH",
                    "name": "Ukraine Hryvnia",
                    "stellar_code": "UAH",
                    "stellar_issuer": "GBWUVXEBXYAJITVDD6PEZAY4SBBEAOQFVPFJC4PKTWBNIZXSTSAH7LML",
                    "minor_unit": 2
                }
            ],
            "activated": true,
            "registered": true,
            "blocked": false,
            "iban": "AZ21DGOK50994005088730349858"
        }
    ],
    "total": 1
}

Note: a digital entity has one identificator assigned.

Entity has status attributes:

• activated

• registered

• blocked

The attributes are not used currently.

Update a customer

Update customer

put

Update customer

Path parameters

counterparty_guidstringRequired

Counterparty GUID

customer_guidstringRequired

Customer GUID

Body

balance_allowednumberOptional

customer's allowed balance

balance_asset_codestringOptional

optional balance's asset code

balance_asset_issuerstringOptional

optional balance's asset issuer

branch_guidstringOptional

optional customer's branch's name

is_disabledbooleanOptional

if you need to disable an employee you should make this parameter true, default it is false

kyc_levelintegerOptional

customer's level of verification(kyc)

namestringOptional

optional customer's name

paternal_namestringOptional

optional customer's paternal name

phone_numberstringOptional

optional customer's phone number

segmentstringOptional

optional customer's segment: Public Liability (PL) or Professional Indemnity (PI)

statusstringOptional

optional customer's status

surnamestringOptional

optional customer's surname

wallet_user_guidstringOptional

customer's guid

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/counterparty/{counterparty_guid}/customers/{customer_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "balance_allowed": 1,
  "balance_asset_code": "text",
  "balance_asset_issuer": "text",
  "branch_guid": "text",
  "is_disabled": true,
  "kyc_level": 1,
  "name": "text",
  "paternal_name": "text",
  "phone_number": "text",
  "segment": "text",
  "status": "text",
  "surname": "text",
  "wallet_user_guid": "text"
}

{}

List customers per counterparty

To get the list of all customers for the specific counterparty use this endpoint:

Get customers list

get

Get customers list with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

wallet_user_guidsstring[]Optional

Customer's GUIDs

loginsstring[]Optional

Customer's logins

kyc_levelsstring[]Optional

Customer's kyc levels

is_disabledbooleanOptional

Include disabled

min_balance_allowednumberOptional

Customer's allowed balance

max_balance_allowednumberOptional

Customer's allowed balance

balance_asset_codesstring[]Optional

Balance's asset code

balance_asset_issuersstring[]Optional

Balance's asset issuers

branch_guidsstring[]Optional

Customer's branch guids

namesstring[]Optional

Customer's names

paternal_namesstring[]Optional

Customer's paternal names

phone_numbersstring[]Optional

Customer's phone numbers

segmentsstring[]Optional

Customer's segments

statusesstring[]Optional

Customer's statuses

surnamesstring[]Optional

Customer's surnames

search_stringstringOptional

Parameter to search by name or login

min_created_atstringOptional

Customer's time of creation

max_created_atstringOptional

Customer's time of creation

min_updated_atstringOptional

Customer's time of last update

max_updated_atstringOptional

Customer's time of last update

offsetintegerOptional

Offset

limitintegerOptional

Limit

orderingstring · enumOptional

Ordering

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/customers HTTP/1.1
Host: your_host
Accept: */*

{
  "customers": [
    {
      "balance_allowed": 1,
      "balance_asset_code": "text",
      "balance_asset_issuer": "text",
      "branch_guid": "text",
      "branch_name": "text",
      "counterparty_guid": "text",
      "created_at": "text",
      "is_disabled": true,
      "kyc_level": 1,
      "login": "text",
      "name": "text",
      "paternal_name": "text",
      "phone_number": "text",
      "segment": "text",
      "status": "text",
      "surname": "text",
      "updated_at": "text",
      "wallet_user_guid": "text"
    }
  ],
  "total": 1
}

Response example:

{
    "customers": [
        {
            "wallet_user_guid": "b948d0e4-93c0-43ee-b861-7d699c73a355",
            "counterparty_guid": "e8fd9c29-24d5-4af4-a6b9-933f59e5023d",
            "login": "[e-mail]",
            "kyc_level": 1,
            "is_disabled": false,
            "balance_allowed": 1000,
            "balance_asset_code": "UAH",
            "balance_asset_issuer": "GBWUVXEBXYAJITVDD6PEZAY4SBBEAOQFVPFJC4PKTWBNIZXSTSAH7LML",
            "branch_name": "",
            "name": "NameOfCustomer",
            "paternal_name": "Testik",
            "phone_number": "1124988888888888888888",
            "segment": "test",
            "status": "active",
            "surname": "SurnameOfCustomer",
            "created_at": "2023-07-14T11:31:14.137931Z",
            "updated_at": "2023-07-14T12:27:15.486653Z"
        }
    ],
    "total": 1
}

Get details for a single digital account

Get the account detailed information.

Get account

get

Get account

Path parameters

counterparty_guidstringRequired

Counterparty GUID

account_guidstringRequired

wallet account guid (uuid)

Query parameters

ibanstringOptional

iban (string)

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/accounts/{account_guid} HTTP/1.1
Host: your_host
Accept: */*

{
  "activated": true,
  "assets": [
    {
      "activated": true,
      "balance": 1,
      "code": "text",
      "minor_unit": 1,
      "name": "text",
      "platform": "text",
      "stellar_code": "text",
      "stellar_issuer": "text"
    }
  ],
  "assets_total": 1,
  "blocked": true,
  "guid": "text",
  "iban": "text",
  "name": "text",
  "platform": "text",
  "registered": true,
  "type": "text"
}