Filter by branch

Note: if you use branches you can also filter by branch.

Show digital entity corresponding to the branch

Get branch accounts list

get

Get branch accounts list

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Query parameters

wallet_account_guidsstring[]Optional

wallet account guid (uuid)

wallet_user_guidsstring[]Optional

wallet user guid (uuid)

account_kindsstring[]Optional

account kinds (string)

search_stringstringOptional

Parameter to search by guid, iban, login or external_id

ibanstringOptional

iban

offsetintegerOptional

offset (int)

orderstring · enumOptional

list order (string)

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

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

[
  {
    "accounts": [
      {
        "account_kind": "processing",
        "counterparty_guid": "text",
        "created_at": "text",
        "iban": "text",
        "stellar_address": "text",
        "updated_at": "text",
        "wallet_account_guid": "text",
        "wallet_user_external_id": "text",
        "wallet_user_guid": "text"
      }
    ],
    "total": 1
  }
]

Show employees corresponding to the branch

Get branch's employees

get

Get branch's employees

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Query parameters

guidsstring[]Optional

Employee's GUIDs

loginsstring[]Optional

Employee's logins

namesstring[]Optional

Employee's names

is_disabledbooleanOptional

Include disabled

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}/branch/{branch_guid}/employees HTTP/1.1
Host: your_host
Accept: */*

[
  {
    "branch_guid": "text",
    "branch_name": "text",
    "counterparty_guid": "text",
    "created_at": "text",
    "guid": "text",
    "is_disabled": true,
    "login": "text",
    "name": "text",
    "paternal_name": "text",
    "phone": "text",
    "surname": "text",
    "updated_at": "text"
  }
]

Get customers' list corresponding to the specific branch

To get the list of all customers who are added to the specific branch use this endpoint:

Get customers list

get

Get customers list with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Query parameters

wallet_user_guidsstring[]Optional

Customer's GUIDs

counterparty_guidsstring[]Optional

Counterparty'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

ibanstring[]Optional

IBANs

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}/branch/{branch_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
}

Get customer's entity corresponding to the customer of specific branch

Customer's accounts

get

Get customer's accounts on behalf of employee

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch 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}/branch/{branch_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
}