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

Identifiers

PreviousDigital entityNextTransfer

Last updated 1 year ago

You have the following possibilities:

  • Create identifiers

  • view Identifier's history

  • Delete identifiers

Please note:

  1. the creating and deleting identifiers operation requires approval from a DCM operations officer

  2. only 1 request for creating or deleting can have a "created" status

Create identifiers

To create identifiers use this endpoint:

A condition must be met:

ReserveAccBalance>=sum(create)โˆ’sum(delete)+XReserve Acc Balance >= sum(create) - sum(delete) + XReserveAccBalance>=sum(create)โˆ’sum(delete)+X

where:

  • X - requested amount to create

  • sum(A) - history of all created or deleted identifiers

Identifier's history

To view the identifier's history use this request:

Delete identifiers

To delete identifiers use this endpoint:

A condition must be met:

ReserveAccBalance>=sum(create)โˆ’sum(delete)โˆ’YReserve Acc Balance >= sum(create) - sum(delete) - YReserveAccBalance>=sum(create)โˆ’sum(delete)โˆ’Y

where:

  • Y - requested amount to delete

  • sum(A) - history of all created or deleted identifiers

๐Ÿ› ๏ธ

Assets history

get

Assets history

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
guidsstring[]Optional

Emission GUIDs

directionstringOptional

Direction

balance_guidstringOptional

Balance GUID

asset_codestringOptional

Asset code

asset_issuerstringOptional

Asset issuer

issuer_payment_guidstringOptional

Issuer payment GUID

emission_payment_guidstringOptional

Emission payment GUID

issuer_payment_hashstringOptional

Issuer payment hash

emission_payment_hashstringOptional

Emission payment hash

min_requested_amountstringOptional

Min requested amount

max_requested_amountstringOptional

Max requested amount

statusstringOptional

Status

created_bystringOptional

Created by

updated_bystringOptional

Updated by

min_created_atstringOptional

Min created_at

max_created_atstringOptional

Max created_at

min_updated_atstringOptional

Min updated_at

max_updated_atstringOptional

Max updated_at

orderstring ยท enumOptional

Sorting order

Possible values:
offsetintegerOptional

Offset

limitintegerOptional

Limit

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/emission/history HTTP/1.1
Host: your_host
Accept: */*
{
  "history": [
    {
      "balance": {
        "asset_code": "text",
        "counterparty_guid": "text",
        "created_at": "text",
        "emission_account_guid": "text",
        "guid": "text",
        "reserve_balance_amount": 1,
        "updated_at": "text"
      },
      "created_at": "text",
      "created_by": "text",
      "direction": "text",
      "emission_payment_guid": "text",
      "emission_payment_hash": "text",
      "guid": "text",
      "issuer_payment_guid": "text",
      "issuer_payment_hash": "text",
      "requested_amount": 1,
      "reserve_balance_amount": 1,
      "status": "text",
      "updated_at": "text",
      "updated_by": "text"
    }
  ],
  "total": 1
}
  • Create identifiers
  • POSTIssue asset
  • Identifier's history
  • GETAssets history
  • Delete identifiers
  • POSTBurn asset

Issue asset

post

Issue asset

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
amountnumberOptional

amount of issued assets

asset_codestringOptional

asset code that will be created

asset_issuerstringOptional

address in stellar which will issue token

reserve_balancenumberOptional

optional reserve balance

Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/emission/issue HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "reserve_balance": 1
}
{}

Burn asset

post

Burn asset

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
amountnumberOptional

amount of tokens that will be burnt

asset_codestringOptional

asset's code

asset_issuerstringOptional

address in stellar that is the issuer address

reserve_balancenumberOptional

optional reserve balance

Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/emission/burn HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "reserve_balance": 1
}
{}