Integration Guide for Banks
[ENG] Integration Guide for Bank
[ENG] Integration Guide for Bank
  • General
    • ๐Ÿ’ฐOverview
      • Transfers between digitized entities
        • Option 1. Fast transfer
        • Option 2. Standard transfer (optional)
      • Version history
      • API change log
      • Glossary
    • ๐ŸŒCommon requirements
    • ๐Ÿ‘‰Basic use case
    • ๐Ÿ“…Integration Plan
      • Integration Plan - Business
      • Integration Plan - Technical Team
      • Multisignature
    • โ—Error messages
  • ๐Ÿ› ๏ธAPI methods
    • Authentification
      • Authorization via JWT
      • Bank authorization
      • JWT format
    • Emlpoyee
      • How to add a user to a role
      • Role management
    • Customer
      • Segments
    • Digital entity
    • Identifiers
    • Transfer
      • Multisignature for transfers
      • [optional] Callbacks
      • Category
    • Limits
    • Reconciliation
    • [optional] Branch
      • Branch access
      • How to add employee to branch
      • Filter by branch
      • Transfers (branches)
      • Branch digital entity
Powered by GitBook
On this page
  1. API methods
  2. [optional] Branch

Branch digital entity

PreviousTransfers (branches)

Last updated 1 year ago

Create a branch processing entity

Show entity belonging to a 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
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
  }
]
  • Create a branch processing entity
  • POSTCreate branch processing account
  • Show entity belonging to a branch
  • GETGet branch accounts list

Create branch processing account

post

Create branch processing account

Path parameters
counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Body
account_kindall ofOptional

type of account: processing or emission (for branch accounts only processing type is possible)

Possible values:
string ยท enumOptionalPossible values:
ibanstringOptional
key_keeper_loginstringOptional
Responses
200
OK
application/json
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/accounts HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "account_kind": "processing",
  "iban": "text",
  "key_keeper_login": "text"
}
{
  "guid": "text"
}