Customer
Working with customers you have the following features:
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
Counterparty GUID
required Asset's code of e-money currency
required Address in stellar which issues token
optional default 0, customer's allowed balance
optional Balance's asset code
optional Balance's asset issuers
optional Branch's GUID
optional IBAN
If you need to disable an employee you should make this parameter true, default it is false
optional default 0, customer's level of verification(KYC)
Login unique user name phone, email or other
optional Customer's name
optional Customer's paternal name
optional Customer's phone number
optional Customer's segment: Public Liability (PL) or Professional Indemnity (PI)
optional Customer's status
optional Customer's surname
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.
Get customer's accounts
To show customer's accounts, you should use this endpoint:
Get customer's accounts on behalf of employee
Counterparty GUID
Customer GUID
iban (string)
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
}Update a customer
Update customer
Counterparty GUID
Customer GUID
customer's allowed balance
optional balance's asset code
optional balance's asset issuer
optional customer's branch's name
if you need to disable an employee you should make this parameter true, default it is false
customer's level of verification(kyc)
optional customer's name
optional customer's paternal name
optional customer's phone number
optional customer's segment: Public Liability (PL) or Professional Indemnity (PI)
optional customer's status
optional customer's surname
customer's guid
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 with filter
Counterparty GUID
Customer's GUIDs
Customer's logins
Customer's kyc levels
Include disabled
Customer's allowed balance
Customer's allowed balance
Balance's asset code
Balance's asset issuers
Customer's branch guids
Customer's names
Customer's paternal names
Customer's phone numbers
Customer's segments
Customer's statuses
Customer's surnames
Parameter to search by name or login
Customer's time of creation
Customer's time of creation
Customer's time of last update
Customer's time of last update
Offset
Limit
Ordering
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
}Get details for a single digital account
Get the account detailed information.
Get account
Counterparty GUID
wallet account guid (uuid)
iban (string)
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"
}Last updated