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. Transfer

Category

Transfers have an attribute category.

Parameter when performing operations, in which the value of the type of operation is transferred Information is provided by the Bank during operations for further storage of identifiers in DCM. Directory of the main types of operations (if necessary, the list can be expanded).

Now it can have the following value:

Value
Description

01

Cash withdrawal at an ATM

02

Cash withdrawal at the bank's cash desk

03

Cash withdrawal from POS

04

Cash replenishment through the bank's cash desk

10

Payment by requisites

11

Payment for eCOM services (within the bank)

12

Payment for eCOM services (third-party resources)

13

Payment by POS

14

Payment via QR ("DirectPay")

20

Transfer to account (within the bank)

21

Transfer to an account (to another bank)

30

Transfer from another account (within the bank)

31

Top up from another account (third-party bank/resource)

32

Card top-up

40

Deduction of bank commission

50

Technical payments (chargebacks, etc. operations)

51

Full refund

52

Refund of part of the amount

Get transfer categories

Create transfer categories

Update transfer categories

Delete transfer categories

Previous[optional] CallbacksNextLimits

Last updated 1 year ago

🛠️

Get payment's categories

get

Get payment's categories

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/dictionary/payment/category HTTP/1.1
Host: your_host
Accept: */*
{
  "categories": [
    {
      "created_at": "text",
      "deleted_at": "text",
      "description": "text",
      "guid": "text",
      "name": "text",
      "updated_at": "text"
    }
  ]
}

Delete payment's categories

delete

Delete payment's categories

Path parameters
category_guidstringRequired

Payment category GUID

Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
delete
DELETE /api/v1/dictionary/payment/category/{category_guid} HTTP/1.1
Host: your_host
Accept: */*
{}
  • Get transfer categories
  • GETGet payment's categories
  • Create transfer categories
  • POSTCreate payment's categories
  • Update transfer categories
  • PUTUpdate payment's categories
  • Delete transfer categories
  • DELETEDelete payment's categories

Create payment's categories

post

Create payment's categories

Body
descriptionstringOptional
namestringOptional
Responses
200
OK
application/json
400
json with error msg
application/json
post
POST /api/v1/dictionary/payment/category HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "text",
  "name": "text"
}
{
  "guid": "text"
}

Update payment's categories

put

Update payment's categories

Path parameters
category_guidstringRequired

Payment category GUID

Body
descriptionstringOptional
namestringOptional
Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
put
PUT /api/v1/dictionary/payment/category/{category_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "text",
  "name": "text"
}
{}