logo
API docs by Redocly

FinteqHub Backoffice API Reference

Download OpenAPI specification:Download

AuditLog

List audit logs

list audit log by user id

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "logs": [
    ]
}

Auth

Login

login

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

User login credentials

password
required
string [ 8 .. 32 ] characters
username
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "lastActiveAt": "2020-12-08T16:38:09.70516+03:00",
  • "metadata": {},
  • "mfa": {
    },
  • "passwordExpired": true,
  • "passwordWillExpireAt": "2020-12-08T16:38:09.70516+03:00",
  • "startedAt": "2020-12-08T16:38:09.70516+03:00",
  • "token": "s.utnmgOPwTF8elMkPM5DBCBN7",
  • "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "willExpireAt": "2020-12-08T16:38:09.70516+03:00"
}

Login with One-Time token

login with one-time token

query Parameters
merchantId
required
string

Merchant short ID, provided to you by the FinteqHub team.

fingerprint
required
string = 32 characters

Fingerprint

token
required
string

Token

requestId
string <uuid> (ULID)
Example: requestId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Logout

logout

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

GetTotpBarcode

get totp png base64 image

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "barcode": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy0BAAAGXklEQVR4nOyd4Y4iOQyEmRPv/8p7upX6BJm4XbbDbK30fT9GAtJJhpLjdhw3z1+/HmDEP396AvDO878/X1+9i1frWvu5Po/6Xz+P2kft1nFVa1f7z+YdjT/5PrEQMxDEDAQx4/n6orsGr6z9ZP1mviMbP/MBav/R6/U61Ud0vk8sxAwEMQNBzHju3lTvv6P2ajwS9Ve9zz+9pkfjRp+r/SjzwULMQBAzEMSMrQ/pUo0bouun7dW9LXVvrBq/TMBCzEAQMxDEjKM+JFqT17W4mu9Y+49eq/OL3r/GVX3CJ7KtWIgZCGIGgpix9SHTtXGa4476qfoa1adVc+HV/6/yfWIhZiCIGQhixpsP6Z4nulD3lqavV7q+Yvo6G7/zfWIhZiCIGQhixteJ/Rh1Da3e71d9RjRul2ocdeK7xELMQBAzEMSM3z6ku6dTrdOo1l9M6y5O7clVx5n4SCzEDAQxA0HMuN3L+qlavqj9itpePY+VtVdrHqfzeQULMQNBzEAQM97ikAv1vr/brltTeCp/svarcjLe2F1PnbohCGIGgphRqjG8mJ6PmtYMVnP363Vqv6d8qZrzf2AhfiCIGQhixm0c8n+jQ8+7+jZ4cY3PrlfHO/1Ml+45st18sRAzEMQMBDHjdxyixgPqs0lWsvvwqH00zrSO41R80p3XXXssxAwEMQNBzJCeuaieo6pedzGtb1/76fqgLH6ofg+dZ65gIWYgiBkIYsbbs9/V+/EVde1V+62eh1I/r/qIrs+Ixo2uYy/LGAQxA0HMeNvLilDX1OraXc2jVNtPzxJXr6v+HzuwEDMQxAwEMWNbp95d21WmzzBR6066e07dPMq0XoW9LEMQxAwEMUOqUz+1p9ONd07Xz586u6yifp/4EEMQxAwEMUPay7rIcthqTrx6v1/NTX+qZrIbF63v34GFmIEgZiCIGdvfU++e1a3GM2oOPjtvpfbfjS+qeZFJXgcLMQNBzEAQM6Tn9p7OLVdrFqP5TFF9ZXTdqfqTV7AQMxDEDAQx482HdPMPGdN8SjeHr6710zzJidrCB/kQTxDEDAQxY7uXdTGNC9S9pK6vqs6nWzdyej53PhELMQNBzEAQM0o59YtTz/xQfVO3jmOdl0rmE6f5ort5YSFmIIgZCGLGbU69eka3ep+v5sCzcbp5jZXMR0zr+aPPqVM3BkHMQBAzRs/tjejmwj9d05ihzq96nQr5EEMQxAwEMWPrQy6q9/fdevFTcVA0v+n5K7U/tf4lGhcfYgiCmIEgZtw+6+RCXUurvkKlepZ2vS5i+oyTaby0GxcLMQNBzEAQM0r5kKnv6K6xK9X4R13zu+eyJnXpazssxAwEMQNBzNj+fkg3nqjGK9laPz1vleXwq2v+p+vciUMMQRAzEMSM298xrOYDVqrtpmtzt59uHqc6v2zcBxbiB4KYgSBmbOvUV7q577VdOIliXqLr87p7Tere2YnrsRAzEMQMBDFj+zuGar3Gp+rNp3kUtR5lmj/Jxo/GvZsvFmIGgpiBIGbcPi/rW+MPPaeqOs407xL1E1E9lzWpg8FCzEAQMxDEDOk3qC66a7f6fsSn1uz18+o8P+GzsBAzEMQMBDFjm1Ov7L3s3p+2/6lcfoa6ZxaNm50DWyEOMQRBzEAQM7Zne6PX3XilW5M3zbd0c/3ZHpvqY6P+7j7HQsxAEDMQxIxRPqRaT6Kuzemkh7WJ3RrJbJxq7eOuPyzEDAQxA0HMKJ3t/XbxobW/Gmdka/PpPMxPgoWYgSBmIIgZ0m9QrXTP1mb9Ru2y+/hsD2xaM9jN5UfjEIf8RSCIGQhiRus3qLp7ONU6jK4vynxMdn10XdY+m4/SHxZiBoKYgSBm3MYhGdl9/qkzvN18ilpDqF6nxiPVGs3Xz7EQMxDEDAQx4/ZcVoR6fqobZ6h7Vtm81TVejZdWuvHNXXssxAwEMQNBzHju3pyujdO68Ky9Wm+h9qPGJVG/6nyU+WIhZiCIGQhixtaHdFF9hlqLeOrcVPcMQDeOmtTNYyFmIIgZCGLGUR/SPQs73QuL5tGtiVznlc1X/T8iXtthIWYgiBkIYsbWh3T3nNS1dXqe6tReW8S0Hr1b5/LAQvxAEDMQxIw3H9I9nzU9R6XGHdn41dx4d4+rGp9En7OX9ReAIGYgiBlff6IWG2KwEDP+DQAA//+TDHXGhqE4+AAAAABJRU5ErkJggg=="
}

CheckMfaCode

check 2 factor 6-digits code

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

2 factor code

code
required
string = 6 characters

Responses

Request samples

Content type
application/json
{
  • "code": "123456"
}

Response samples

Content type
application/json
{
  • "lastActiveAt": "2020-12-08T16:38:09.70516+03:00",
  • "metadata": {},
  • "mfa": {
    },
  • "passwordExpired": true,
  • "passwordWillExpireAt": "2020-12-08T16:38:09.70516+03:00",
  • "startedAt": "2020-12-08T16:38:09.70516+03:00",
  • "token": "s.utnmgOPwTF8elMkPM5DBCBN7",
  • "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "willExpireAt": "2020-12-08T16:38:09.70516+03:00"
}

ResetMFA

reset mfa for user

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

UpdatePassword

update user password

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

new user password

newPassword
required
string [ 8 .. 32 ] characters
oldPassword
required
string [ 8 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "password",
  • "newPassword": "password2"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

CheckResetPasswordToken

check user reset password token

Authorizations:
PasswordResetToken
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

UpdateResetPassword

update user password when it is reset or create new password after registration

Authorizations:
PasswordResetToken
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
newPassword
required
string [ 8 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "newPassword": "password2"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

ResetPassword

reset user password

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

ResetLoginPassword

reset user login password

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
required
object (MfaCode)
username
string <email>

Responses

Request samples

Content type
application/json
{}

Session

Session

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ],
  • "session": {
    },
  • "unitAccessRights": [
    ],
  • "user": {
    },
  • "roles": [
    ]
}

Config

application config

application config

Responses

Response samples

Content type
application/json
{
  • "release": "v1.0.0"
}

Currency Conversion

Create currency conversion

create currency conversion

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

currency conversion

title
required
string <= 100 characters
required
object (CurrencyConversionConfig)
reason
string <= 250 characters
description
string <= 250 characters
active
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "reason": "string",
  • "description": "string",
  • "active": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "description": "string",
  • "version": 0,
  • "reason": "string",
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "terminalIds": [
    ],
  • "config": {
    }
}

Update currency conversion

update currency conversion

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
lockId
string <uuid> (ULID)
Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

lock ID

releaseLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

currency conversion

title
required
string <= 100 characters
required
object (CurrencyConversionConfig)
reason
string <= 250 characters
description
string <= 250 characters
active
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "reason": "string",
  • "description": "string",
  • "active": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "description": "string",
  • "version": 0,
  • "reason": "string",
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "terminalIds": [
    ],
  • "config": {
    }
}

Get latest currency conversion version

get the latest version of a specific conversion

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "currencyConversion": {
    },
  • "lock": {
    }
}

Delete currency conversion

delete currency conversion

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

List latest currency conversions

list latest currency conversions

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "currencyConversions": [
    ],
  • "terminalInfo": [
    ]
}

List all versions for currency conversion

list all versions for currency conversion

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versions": [
    ]
}

Get currency conversion version

get the version of a specific conversion

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

version
required
integer

entity version

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "description": "string",
  • "version": 0,
  • "reason": "string",
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "terminalIds": [
    ],
  • "config": {
    }
}

List currency conversions info

list currency conversions info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Add terminals currency conversions

add terminals currency conversions

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

terminalIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "terminalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Delete currency conversion from terminals

delete currency conversion from terminals

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

terminalIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "terminalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Update terminal's currency conversions

update currency conversions for а specific terminal

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

currencyConversionIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "currencyConversionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Customer

Customers

list customers

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "customers": [
    ]
}

Customers

get customer by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Update Customer

update customer

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
project
required
string <uuid> (ULID)
Example: project=c41fed51-7b1d-4b8c-89f3-101e26e825f0

project id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Customer

active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Customer Accounts

list all customer accounts

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "customersAccounts": [
    ]
}

Customer customer accounts

List customer accounts

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "customersAccounts": [
    ]
}

Customer account

Get customer account by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

accountUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "customerAccount": {
    }
}

Update customer account

Update customer account

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

accountUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
project
required
string <uuid> (ULID)
Example: project=c41fed51-7b1d-4b8c-89f3-101e26e825f0

project id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update customer account

blockReason
string
status
string (CustomerAccountStatus)
Enum: "new" "blocked" "invisible" "active" "inactive" "deleted" "duplicated"

Responses

Request samples

Content type
application/json
{
  • "blockReason": "Blocked by customer",
  • "status": "new"
}

Response samples

Content type
application/json
{
  • "customerAccount": {
    }
}

Customer Accounts

Customer Accounts

list all customer accounts

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "customersAccounts": [
    ]
}

Customer accounts

Customer customer accounts

List customer accounts

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "customersAccounts": [
    ]
}

Customer account

Get customer account by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

accountUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "customerAccount": {
    }
}

Update customer account

Update customer account

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

accountUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
project
required
string <uuid> (ULID)
Example: project=c41fed51-7b1d-4b8c-89f3-101e26e825f0

project id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update customer account

blockReason
string
status
string (CustomerAccountStatus)
Enum: "new" "blocked" "invisible" "active" "inactive" "deleted" "duplicated"

Responses

Request samples

Content type
application/json
{
  • "blockReason": "Blocked by customer",
  • "status": "new"
}

Response samples

Content type
application/json
{
  • "customerAccount": {
    }
}

Dashboard

dashboards

list dashboards

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "dashboards": [
    ]
}

Create dashboards

create dashboard

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create dashboards

title
required
string [ 1 .. 200 ] characters
object (DashboardView)
Array of objects (DashboardFilter)

Responses

Request samples

Content type
application/json
{
  • "view": {
    },
  • "title": "string",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "dashboard": {
    }
}

Dashboard

get dashboard by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "dashboard": {
    }
}

Update Dashboard

update dashboard

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Dashboard

title
required
string [ 1 .. 200 ] characters
object (DashboardView)
Array of objects (DashboardFilter)

Responses

Request samples

Content type
application/json
{
  • "view": {
    },
  • "title": "string",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "dashboard": {
    }
}

Delete Dashboard

delete dashboard

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Update Dashboard Widgets View

update dashboard widgets view

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Dashboard Widgets View

required
object (DashboardWidgetsView)

Responses

Request samples

Content type
application/json
{
  • "view": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Get Tabular Data

get tabular data by dashboard id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
widgetIds
Array of strings <uuid> (ULID)
object (TabularDataPeriod)
object (OverrideQuery)

Responses

Request samples

Content type
application/json
{
  • "widgetIds": [
    ],
  • "period": {
    },
  • "overrideQuery": {
    }
}

Response samples

Content type
application/json
{
  • "tabularData": {
    }
}

Dictionaries

Get card issuers

get card issuers list

query Parameters
searchQuery
string

search query

header Parameters
x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get terminal config

get terminal config

query Parameters
integrationType
required
string (integrationType)

Integration type

header Parameters
x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "properties": {
    }
}

Get merchant payments config

get merchant payments config

Authorizations:
BearerCookie
query Parameters
merchantId
string

Merchant short ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "integrations": {
    },
  • "paymentMethods": {
    }
}

Get reconciliation integrations

get reconciliation integrations

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "integrations": {
    }
}

Get reconciliation client project names

get reconciliation client project names

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "clientProjectNames": [
    ]
}

Get reconciliation legal entities

get reconciliation legal entities

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "legalEntities": [
    ]
}

Get card levels

get card levels list

query Parameters
searchQuery
string

search query

header Parameters
x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get card types

get card types list

query Parameters
searchQuery
string

search query

header Parameters
x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get card brands

get card brands list

query Parameters
searchQuery
string

search query

header Parameters
x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get rule specifications

get rule specifications

Authorizations:
BearerCookie
query Parameters
merchantId
string

Merchant short ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get cashier credentials

get cashier credentials

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Filter

Create filter

create filter

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
title
required
string [ 1 .. 200 ] characters
Array of objects (DashboardFilter)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "config": [
    ]
}

Response samples

Content type
application/json
{
  • "filter": {
    }
}

List filters

list filters

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Delete batch filter

delete batch filter

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
filterIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "filterIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Update filter

update filter

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
title
required
string [ 1 .. 200 ] characters
Array of objects (DashboardFilter)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "config": [
    ]
}

Response samples

Content type
application/json
{
  • "filter": {
    }
}

Get filter

Get filter

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "filter": {
    }
}

Delete filter

delete filter

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Folder

Create Folder

create folder

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

create folder

title
required
string [ 5 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "folder": {
    }
}

List Folders

list folders

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "folders": [
    ]
}

Update Folder

update folder

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

update folder

title
required
string [ 5 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "folder": {
    }
}

Delete Folder

delete folder

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Get Folder

get folder

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "folder": {
    },
  • "templates": [
    ]
}

Link templates to folder

link templates to folder

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

link templates to folder

templateIds
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "templateIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Unlink templates from folder

unlink templates from folder

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

unlink templates from folder

templateIds
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "templateIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Integration

List Integrations

list integrations

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "integrations": [
    ]
}

Update Integration

update integration

Authorizations:
BearerCookie
path Parameters
name
required
string (integrationType)

Integration type

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Integration

isActive
required
boolean

Responses

Request samples

Content type
application/json
{
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "isActive": true,
  • "title": "PayPal",
  • "type": "string",
  • "paymentMethodsByTransaction": {
    },
  • "hardLimits": {
    },
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Get Integration Details

get integration details

Authorizations:
BearerCookie
path Parameters
name
required
string (integrationType)

Integration type

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "isActive": true,
  • "title": "PayPal",
  • "type": "string",
  • "paymentMethodsByTransaction": {
    },
  • "hardLimits": {
    },
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

KYC Rules

List KYC Rules

List all latest KYC rules

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "kycRules": [
    ]
}

Create KYC Rule

Create KYC rule

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

KYC rule data to create

title
required
string [ 5 .. 100 ] characters
required
Array of objects (kycChain)
active
boolean
description
string <= 250 characters
reason
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "active": true,
  • "chains": [
    ],
  • "description": "string",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "kycRules": [
    ]
}

Update KYC Rule

Update KYC rule

Authorizations:
BearerCookie
path Parameters
ruleId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

KYC rule data to update

title
required
string [ 5 .. 100 ] characters
required
Array of objects (kycChain)
active
boolean
description
string <= 250 characters
reason
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "active": true,
  • "chains": [
    ],
  • "description": "string",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "kycRules": [
    ]
}

Partial Update KYC Rule

Partially update KYC rule

Authorizations:
BearerCookie
path Parameters
ruleId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

KYC rule data to partially update

active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "kycRules": [
    ]
}

Locks

Get locks by scope

Get locks by scope

Authorizations:
BearerCookie
path Parameters
scope
required
string (LockScope)

defines the domain area of the lock

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "locks": [
    ]
}

Get lock info

get lock info

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

scope
required
string (LockScope)

defines the domain area of the lock

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "lock": {
    }
}

Delete lock

delete lock

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

scope
required
string (LockScope)

defines the domain area of the lock

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Extend lock timeout

extend lock timeout

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

scope
required
string (LockScope)

defines the domain area of the lock

query Parameters
tll
string

lock ttl

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "lock": {
    }
}

Merchant

Update Merchant

update merchant

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update merchant

active
required
boolean
businessContact
required
string [ 1 .. 60 ] characters
technicalContact
required
string [ 1 .. 60 ] characters
title
required
string [ 1 .. 30 ] characters
operationAmountRoundType
required
string (DecimalRoundType)
Enum: "up" "down" "math" "to_merchant" "to_customer"
description
string <= 200 characters
customerMetadataSavedPaths
Array of strings
legalEntities
Array of strings

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "businessContact": "Business Contact",
  • "description": "some text",
  • "technicalContact": "Technical Contact",
  • "title": "Merchant title",
  • "operationAmountRoundType": "up",
  • "customerMetadataSavedPaths": [
    ],
  • "legalEntities": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "businessContact": "Business Contact",
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "unit description",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "shortId": "1234567890",
  • "technicalContact": "Technical Contact",
  • "title": "Merchant title",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z",
  • "operationAmountRoundType": "up",
  • "customerMetadataSavedPaths": [
    ],
  • "legalEntities": [
    ]
}

Operation Error

List Operation Errors

list operation errors

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "operationErrors": [
    ],
  • "cursor": { },
  • "fields": { }
}

Create Operation Error Pattern

create operation error pattern

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

operation error pattern

source
required
string
pattern
required
string
groupId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "pattern": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "operationError": {
    }
}

Update Operation Error Pattern

update operation error pattern

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

operation error pattern

source
required
string
pattern
required
string
groupId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "pattern": "string",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "operationError": {
    }
}

List Operation Error Groups

list operation error groups

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "operationErrorGroups": [
    ]
}

Create Operation Error Group

create block rule

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

block rule

title
required
string <= 100 characters
text
string <= 512 characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "operationErrorGroup": {
    }
}

Get Operation Error Group

get block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "operationErrorGroup": {
    }
}

Update Operation Error Group

update block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

block rule

title
required
string <= 100 characters
text
string <= 512 characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "operationErrorGroup": {
    }
}

Delete Operation Error Group

delete block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Attach Operation Error Group

attach operation error group

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

operation error group

errorIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "errorIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorIds": [
    ]
}

Detach Operation Error Group

detach operation error group

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

operation error group

errorIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "errorIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorIds": [
    ]
}

Operations

List operations

list operations

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "operations": [
    ]
}

Get operation

get operation

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Operation ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "operation": {
    },
  • "transaction": {
    },
  • "customer": {
    },
  • "customerAccount": {
    },
  • "operationLogs": [
    ],
  • "operationCommunicationLogs": [
    ]
}

Update operation

update operation

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Operation ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

update operation settled

settled
boolean or null (NullBoolean)

Responses

Request samples

Content type
application/json
{
  • "settled": true
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Check operation status

check operation status

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Operation ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Check operation status

check operation status

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Operation ID

jobType
required
string (jobType)
Enum: "merchant-operation-callback" "sync-operation"

Job type

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Project

Create Project

create project

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Project

parentId
required
string <uuid> (ULID)
title
required
string [ 1 .. 30 ] characters
timezone
required
string <rfc6557-time-zone> (Timezone)
description
string <= 200 characters
failUrl
string <uri> (NullHttpURL)
callbackUrl
string <uri> (NullHttpURL)
detailedCallbackUrl
string <uri> (NullHttpURL)
authCallbackUrl
string <uri> (NullHttpURL)
successUrl
string <uri> (NullHttpURL)
useDelayedDeposit
boolean
useRiskyFallbackFlow
boolean
config
string
Array of objects (projectCashierConfig)

Responses

Request samples

Content type
application/json
{
  • "description": "project description",
  • "failUrl": "http(s)://google.com",
  • "callbackUrl": "http(s)://google.com",
  • "detailedCallbackUrl": "http(s)://google.com",
  • "authCallbackUrl": "http(s)://google.com",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "successUrl": "http(s)://google.com",
  • "title": "Project Group title",
  • "timezone": "Europe/Minsk",
  • "useDelayedDeposit": true,
  • "useRiskyFallbackFlow": true,
  • "config": "string",
  • "cashierConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "unit description",
  • "failUrl": "http(s)://google.com",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "callbackUrl": "http(s)://google.com",
  • "detailedCallbackUrl": "http(s)://google.com",
  • "authCallbackUrl": "http(s)://google.com",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "scenarios": [
    ],
  • "shortId": "1234567890",
  • "successUrl": "http(s)://google.com",
  • "title": "Project title",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z",
  • "timezone": "Europe/Minsk",
  • "useDelayedDeposit": true,
  • "useRiskyFallbackFlow": true,
  • "config": "string",
  • "cashierConfig": [
    ]
}

Update Project

update project

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Project

active
required
boolean
parentId
required
string <uuid> (ULID)
title
required
string [ 1 .. 30 ] characters
timezone
required
string <rfc6557-time-zone> (Timezone)
description
string <= 200 characters
failUrl
string <uri> (NullHttpURL)
callbackUrl
string <uri> (NullHttpURL)
detailedCallbackUrl
string <uri> (NullHttpURL)
authCallbackUrl
string <uri> (NullHttpURL)
successUrl
string <uri> (NullHttpURL)
useDelayedDeposit
boolean
useRiskyFallbackFlow
boolean
config
string
Array of objects (projectCashierConfig)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "description": "project description",
  • "failUrl": "http(s)://google.com",
  • "callbackUrl": "http(s)://google.com",
  • "detailedCallbackUrl": "http(s)://google.com",
  • "authCallbackUrl": "http(s)://google.com",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "successUrl": "http(s)://google.com",
  • "title": "Project Group title",
  • "timezone": "Europe/Minsk",
  • "useDelayedDeposit": true,
  • "useRiskyFallbackFlow": true,
  • "config": "string",
  • "cashierConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "unit description",
  • "failUrl": "http(s)://google.com",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "callbackUrl": "http(s)://google.com",
  • "detailedCallbackUrl": "http(s)://google.com",
  • "authCallbackUrl": "http(s)://google.com",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "scenarios": [
    ],
  • "shortId": "1234567890",
  • "successUrl": "http(s)://google.com",
  • "title": "Project title",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z",
  • "timezone": "Europe/Minsk",
  • "useDelayedDeposit": true,
  • "useRiskyFallbackFlow": true,
  • "config": "string",
  • "cashierConfig": [
    ]
}

Update Project Scenarios

update project

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Patch project scenarios

scenarios
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "scenarios": [
    ]
}

Response samples

Content type
application/json
{
  • "projectScenarios": [
    ]
}

Get Payment Methods

get payment methods

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
txType
string (transactionType)
Enum: "deposit" "withdrawal"

Transaction type

currencyCode
string <iso4217-currency-code> (currencyCode) [ 3 .. 7 ] characters
Enum: "AFN" "EUR" "ALL" "DZD" "USD" "AOA" "XCD" "ARS" "AMD" "AWG" "AUD" "AZN" "BSD" "BHD" "BDT" "BBD" "BYN" "BZD" "XOF" "BMD" "INR" "BTN" "BOB" "BOV" "BAM" "BWP" "NOK" "BRL" "BND" "BGN" "BIF" "CVE" "KHR" "XAF" "CAD" "KYD" "CLP" "CLF" "CNY" "COP" "COU" "KMF" "CDF" "NZD" "CRC" "CUP" "CUC" "ANG" "CZK" "DKK" "DJF" "DOP" "EGP" "SVC" "ERN" "SZL" "ETB" "FKP" "FJD" "XPF" "GMD" "GEL" "GHS" "GIP" "GTQ" "GBP" "GNF" "GYD" "HTG" "HNL" "HKD" "HUF" "ISK" "IDR" "IRR" "IQD" "ILS" "JMD" "JPY" "JOD" "KZT" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "ZAR" "LRD" "LYD" "CHF" "MOP" "MKD" "MGA" "MWK" "MYR" "MVR" "MRU" "MUR" "MXN" "MXV" "MDL" "MNT" "MAD" "MZN" "MMK" "NAD" "NPR" "NIO" "NGN" "OMR" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "PLN" "QAR" "RON" "RUB" "RWF" "SHP" "WST" "STN" "SAR" "RSD" "SCR" "SLE" "SGD" "SBD" "SOS" "SSP" "LKR" "SDG" "SRD" "SEK" "CHE" "CHW" "SYP" "TWD" "TJS" "TZS" "THB" "TOP" "TTD" "TND" "TRY" "TMT" "UGX" "UAH" "AED" "USN" "UYU" "UYI" "UYW" "UZS" "VUV" "VES" "VED" "VND" "YER" "ZMW" "ZWG" "XTS" "ADA" "APE" "ARB" "ATOM" "AVAX" "BCH" "BNB" "BNB-BSC" "BRZ" "BTC" "CRO" "CSC" "DAI" "DOGE" "ETH" "EURS" "HYPE" "LINK" "LTC" "MON" "OP" "OSMO" "PAXG" "POLYGON" "SAND" "SHIB" "SNACK" "SOL" "TON" "TRUMP" "TRX" "TWT" "UNI" "USDC" "USDCE" "USDT" "VERSE" "WBTC" "XAUT" "XED" "XRP"
Example: currencyCode=EUR

ISO-4217 currency code

countryCode
string <iso3166-alpha-2> (CountryAlpha2) = 2 characters
Enum: "AF" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CD" "CG" "CK" "CR" "HR" "CU" "CW" "CY" "CZ" "CI" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RO" "RU" "RW" "RE" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TM" "TC" "TV" "TR" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AX"
Example: countryCode=AS

ISO-3166-alpha2 country code

withCredentialsSpec
string (Boolean)

show credentials spec for payment method

flowType
string (flowType)
Enum: "direct" "form" "cashier" "initless" "none"

credentials spec by flow (cashier,direct,form). Default: direct

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "availableMethods": {
    }
}

Add Projects Scenario

add scenario to projects

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Add scenario to projects

projectIds
required
Array of strings <uuid> (ULID)
prepend
boolean

Responses

Request samples

Content type
application/json
{
  • "projectIds": [
    ],
  • "prepend": true
}

Response samples

Content type
application/json
{
  • "projectScenarios": [
    ]
}

Delete Projects Scenario

delete scenario from projects

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Delete scenario from projects

projectIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "projectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "projectScenarios": [
    ]
}

ProjectGroup

Create Project Group

create project group

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Project Group

parentId
required
string <uuid> (ULID)
title
required
string [ 1 .. 30 ] characters
description
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "Project Group title",
  • "description": "Project Group description"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "unit description",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "shortId": "1234567890",
  • "title": "Project title",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Update Project Group

update project group

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Project Group

active
required
boolean
parentId
required
string <uuid> (ULID)
title
required
string [ 1 .. 30 ] characters
description
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "description": "some text",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "Project Group title"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "unit description",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "shortId": "1234567890",
  • "title": "Project title",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

ProjectTokens

Get Project Tokens

get project tokens

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "tokens": [
    ]
}

Create Project Tokens

create project token

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

x-totp-code
string <= 6 characters

TOTP code

Request Body schema: application/json

Create Project Token

title
required
string [ 1 .. 200 ] characters
required
object (ProjectTokenClaims)
expireAt
string or null (NullTime)

Responses

Request samples

Content type
application/json
{
  • "title": "token name",
  • "expireAt": "2020-12-08T16:38:09.70516Z",
  • "claims": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "token name",
  • "active": true,
  • "expireAt": "2020-12-08T16:38:09.70516Z",
  • "token": "badcafebadc0ffeebadbabebadf00d0000badcafebadc0ffeebadbabebadf00dbadcafebadc0ffeebadbabebadf00d0000badcafebadc0ffeebadbabebadf00d",
  • "claims": {
    },
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Get Project Token

get project token

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

tokenUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "token name",
  • "active": true,
  • "expireAt": "2020-12-08T16:38:09.70516Z",
  • "claims": {
    },
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Update Project Token

Update project token

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

tokenUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

x-totp-code
string <= 6 characters

TOTP code

Request Body schema: application/json

update project token

title
required
string
required
object (ProjectTokenClaims)
expireAt
string or null (NullTime)

Responses

Request samples

Content type
application/json
{
  • "title": "token name",
  • "claims": {
    },
  • "expireAt": "2020-12-08T16:38:09.70516Z"
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "token name",
  • "active": true,
  • "expireAt": "2020-12-08T16:38:09.70516Z",
  • "claims": {
    },
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Deactivate Project Token

deactivate project token

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

tokenUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "token name",
  • "active": true,
  • "expireAt": "2020-12-08T16:38:09.70516Z",
  • "claims": {
    },
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Reconciliation

Retrieve reconciled operations

Retrieve reconciled operations

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "reconciliations": [
    ]
}

Retrieve reconciled operations (POST version)

Retrieve reconciled operations (POST version)

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "reconciliations": [
    ]
}

Retrieve reconciliation aggregates

Retrieve reconciliation aggregates

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

groups
string (ReconciliationGroupsByType)

comma-separated groups

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "totals": {
    },
  • "allAvailableIntegrationDataPeriods": {
    }
}

Retrieve reconciliation aggregates (POST version)

Retrieve reconciliation aggregates (POST version)

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "totals": {
    },
  • "allAvailableIntegrationDataPeriods": {
    }
}

Retrieve reconciliation aggregates totals

Retrieve reconciliation aggregates totals

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "totals": {
    }
}

Retrieve reconciliation grouped aggregates

Retrieve reconciliation grouped aggregates

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Retrieve reconciliation aggregates titles

Retrieve reconciliation aggregates titles

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "group": "string",
  • "titles": [
    ]
}

Mark reconciled operation as confirmed

Mark reconciled operation as confirmed

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Reconciliations Confirmation

query
required
string
forceConsistent
required
boolean
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "forceConsistent": true,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Retrieve all reconciliation reports for user

Retrieve all reconciliation reports for user

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Create reconciliation report

Create reconciliation report

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create reconciliation report

query
string
groups
Array of strings (reconciliationGroupByType)
Items Enum: "integration" "payment_method" "project_id" "project_group_id" "currency_code" "transaction_type" "operation_type" "client_project_name" "legal_entity" "operation_status" "inconsistency_type" "pgw_terminal_id"
type
string (reconciliationsReportType)
Enum: "reconciliations" "summary"

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "groups": [
    ],
  • "type": "reconciliations"
}

Response samples

Content type
application/json
{
  • "reportID": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "status": "in_progress",
  • "type": "reconciliations"
}

Retrieve reconciliation report with download link for user

Retrieve reconciliation report with download link for user

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "report": {
    }
}

Upload integration operations file

The request is utilized to upload files with Integration operations in different format via Backoffice API in storage

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/octet-stream

Upload integration operations request

string <binary> (RawPayload)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Process uploaded integration operations file

The request is utilized to process Integration operations, to map and store them in DB

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Process integration operations request

fileId
required
string <uuid> (ULID)
integration
required
string
source
required
string
filename
string

Responses

Request samples

Content type
application/json
{
  • "fileId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integration": "string",
  • "source": "string",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Process integration commissions report

The request is utilized to process Integration commissions report

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Process integration commissions report request

fileId
required
string <uuid> (ULID)
integration
required
string
legalEntity
required
string
reportFrom
required
string (Time)
reportTo
required
string (Time)

Responses

Request samples

Content type
application/json
{
  • "fileId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integration": "string",
  • "legalEntity": "string",
  • "reportFrom": "2020-12-08T16:38:09.70516+03:00",
  • "reportTo": "2020-12-08T16:38:09.70516+03:00"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Encrypt lavanderia integration credentials

The request is utilized to encrypt lavanderia integration credentials

Authorizations:
BearerCookie
path Parameters
lavanderiaIntegrationType
required
string >= 2 characters

Lavanderia integration type

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Encrypt lavanderia credentials request

credentials
required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Run lavanderia job

The request is utilized to run lavanderia jobs

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Run lavanderia job request

job
required
string (ReconciliationJob)
Enum: "collectIntegrationOperations" "checkLavanderiaEventLogs" "sendIntegrationCollectionNotifications" "collectMerchantKafkaOperation" "checkSlackNotifications" "deleteOperationsData" "saveCommand"
params
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Retrieve events log

Retrieve events log

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "eventsLog": [
    ]
}

Retrieve events log (POST version)

Retrieve events log (POST version)

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
query
string

pgwql query

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "eventsLog": [
    ]
}

Get status of reconciliations

The request is utilized to get status of reconciliations

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "reconciliationsInProgress": true
}

Get unavailable periods of reconciliations

The request is utilized to get information about dates without data

Authorizations:
BearerCookie
query Parameters
dateFrom
string or null (NullTime)
Example: dateFrom=2020-12-08T16:38:09.70516Z

date from query

dateTo
string or null (NullTime)
Example: dateTo=2020-12-08T16:38:09.70516Z

date to query

integration
string (LavanderiaIntegrationTypes)

comma-separated integration types

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "unavailableIntegrationDataPeriods": {
    }
}

Transaction Report

Get Transaction Reports

get transaction reports

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Create Transaction Report

create transaction report

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create transaction report

title
required
string [ 1 .. 100 ] characters
required
object (TransactionReportConfig)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "report": {
    }
}

Get Transaction Report

get transaction report

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "report": {
    }
}

Download Transaction Report

download transaction report

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Role

Roles

list roles

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Create Role

create role

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Role

title
required
string
permissions
required
Array of strings (permission)
Items Enum: "create-structural-unit" "update-structural-unit" "list-users" "create-user" "update-user" "reset-user-password" "reset-user-mfa" "update-user-permissions" "update-user-unit-access" "list-audit-logs" "list-integrations" "manage-integrations" "update-integration-name" "list-terminals" "create-terminal" "update-terminal" "list-templates" "create-template" "update-template" "manage-processing-settings" "list-transactions" "manage-transactions" "list-block-rules" "manage-block-rules" "list-velocity-rules" "manage-velocity-rules" "list-approval-rules" "manage-approval-rules" "list-kyc-rules" "manage-kyc-rules" "create-tokens" "manage-tokens" "list-customers" "update-customer" "list-customer-accounts" "update-customer-account" "merchant-operation-callback" "sync-operation" "view-analytics" "manage-analytics" "process-refund" "create-report" "list-reconciliations" "manage-reconciliations" "create-currency-conversion" "update-currency-conversion" "list-currency-conversions" "manage-errors" "poc-hidden-feature"

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "permissions": [
    ],
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Role

get role by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Role ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "role": {
    },
  • "usersInfo": [
    ]
}

Update role

update role

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Role ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Role

title
required
string
permissions
required
Array of strings (permission)
Items Enum: "create-structural-unit" "update-structural-unit" "list-users" "create-user" "update-user" "reset-user-password" "reset-user-mfa" "update-user-permissions" "update-user-unit-access" "list-audit-logs" "list-integrations" "manage-integrations" "update-integration-name" "list-terminals" "create-terminal" "update-terminal" "list-templates" "create-template" "update-template" "manage-processing-settings" "list-transactions" "manage-transactions" "list-block-rules" "manage-block-rules" "list-velocity-rules" "manage-velocity-rules" "list-approval-rules" "manage-approval-rules" "list-kyc-rules" "manage-kyc-rules" "create-tokens" "manage-tokens" "list-customers" "update-customer" "list-customer-accounts" "update-customer-account" "merchant-operation-callback" "sync-operation" "view-analytics" "manage-analytics" "process-refund" "create-report" "list-reconciliations" "manage-reconciliations" "create-currency-conversion" "update-currency-conversion" "list-currency-conversions" "manage-errors" "poc-hidden-feature"

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "permissions": [
    ],
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Delete role

delete role

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Role ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Create Role

create role and add to users

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Role And Add To Users

required
object (RoleRequest)
userIds
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "role": {
    },
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "permissions": [
    ],
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Approval Rule

Create Approval Rule

create approval rule

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

approval rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "approvalRule": {
    }
}

Update Approval Rule

update approval rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
lockId
string <uuid> (ULID)
Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

lock ID

releaseLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

approval rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
id
required
string <uuid> (ULID)
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "approvalRule": {
    }
}

Delete Approval Rule

delete approval rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Get latest Approval Rule

get latest approval rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "approvalRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

List Latest Approval Rules

list latest approval rules

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "approvalRules": [
    ],
  • "terminalInfo": [
    ]
}

List all versions for Approval Rule

list all versions for approval rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versions": [
    ]
}

Get version for Approval Rule

get version for approval rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

version
required
integer

entity version

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "approvalRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

List Latest Approval Rules info

list approval rules info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Block Rule

Create Block Rule

create block rule

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

block rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "blockRule": {
    }
}

List Latest Block Rules

list latest block rules

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "blockRules": [
    ],
  • "terminalInfo": [
    ]
}

Get latest Block Rule

get latest block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "blockRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

Update Block Rule

update block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
lockId
string <uuid> (ULID)
Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

lock ID

releaseLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

block rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
id
required
string <uuid> (ULID)
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "blockRule": {
    }
}

Delete Block Rule

delete block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

list all versions for Block Rule

list all versions for block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versions": [
    ]
}

get version for Block Rule

Get version for block rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

version
required
integer

entity version

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "blockRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

List Latest Block Rules info

list block rules info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Velocity Rule

Create Velocity Rule

velocity block rule

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

velocity rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "velocityRule": {
    }
}

List Latest Velocity Rules

list latest velocity rules

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "velocityRules": [
    ],
  • "terminalInfo": [
    ]
}

Get latest Velocity Rule

get latest velocity rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "velocityRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

Update Velocity Rule

update velocity rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
lockId
string <uuid> (ULID)
Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

lock ID

releaseLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

block rule

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
id
required
string <uuid> (ULID)
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "velocityRule": {
    }
}

Delete Velocity Rule

delete velocity rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

List all versions for velocity rule

list all versions for velocity rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versions": [
    ]
}

Get Velocity Rule Version

get a specific version for velocity rule

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

version
required
integer

entity version

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "velocityRule": {
    },
  • "terminalInfo": [
    ],
  • "lock": {
    }
}

List Velocity Rules info

list velocity rules info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Scenario

Create Scenario

create scenario

Authorizations:
BearerCookie
path Parameters
unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

template

required
object (Mask)
templateId
required
string <uuid> (ULID)
active
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "mask": {
    },
  • "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Response samples

Content type
application/json
{
  • "scenario": {
    }
}

List Latest Scenarios

list latest scenarios

Authorizations:
BearerCookie
path Parameters
unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

query Parameters
template
string <uuid> (ULID)
Example: template=c41fed51-7b1d-4b8c-89f3-101e26e825f0

template id

withAncestors
string (Boolean)

include ancestors, ascendant in hierarchy structural units

withDescendants
string (Boolean)

include descendant in hierarchy structural units

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "scenarios": [
    ]
}

Update Scenario

update scenario

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

template

required
object (Mask)
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "mask": {
    }
}

Response samples

Content type
application/json
{
  • "scenario": {
    }
}

Get latest scenario

get latest scenario

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "scenario": {
    }
}

Delete Scenario

delete scenario

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

list all versions for scenario

list all versions for scenario

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

unitId
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

structural unit id

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "scenarios": [
    ]
}

Search Text In Field In Customers

search text in field in customers

Authorizations:
BearerCookie
query Parameters
field
required
string (searchCustomerField)
Enum: "merchantCustomerId" "name" "email" "phoneNumber"

search field

text
required
string >= 2 characters

text to search in field

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Search Text In Field In Operations

search text field in operations

Authorizations:
BearerCookie
query Parameters
field
required
string (searchOperationField)
Enum: "integrationStatusCode" "errors" "paymentInstrument" "customerIp" "customerOs" "customerBrowser" "customerDevice" "cardIin" "cardIssuer" "fallbackReasons" "customerEmail" "customerIpPostalCode" "customerIpCity" "customerIpRegion" "merchantOperationId" "integrationOperationId" "integrationAccountId"

search field

text
required
string >= 2 characters

text to search in field

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

StructuralUnits

Get Merchant Structural Units Hierarchy

get structural units by id

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "merchant": {
    },
  • "merchantAdmin": {
    },
  • "projectGroups": [
    ],
  • "projects": [
    ],
  • "wlaMerchants": [
    ],
  • "unitAccessRights": [
    ]
}

Template

Create Template

create template

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

template

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "chains": [
    ],
  • "endpoints": {
    },
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "template": {
    },
  • "lock": {
    }
}

List Latest Templates

list latest templates

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ],
  • "terminalInfo": [
    ]
}

Get latest template

get latest template

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
withLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "template": {
    },
  • "terminalInfo": [
    ],
  • "readOnly": true,
  • "lock": {
    }
}

Update Template

update template

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

query Parameters
lockId
string <uuid> (ULID)
Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0

lock ID

releaseLock
string (Boolean)

lock management boolean variable

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

template

required
Array of objects (Chain)
required
object
title
required
string [ 5 .. 100 ] characters
active
boolean
reason
string <= 250 characters
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "title": "string",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "template": {
    },
  • "lock": {
    }
}

list all versions for template

list all versions for template

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versions": [
    ]
}

Get template version

get a specific version for template

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

version
required
integer

entity version

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "template": {
    },
  • "terminalInfo": [
    ],
  • "readOnly": true,
  • "lock": {
    }
}

Generate new template

Generate new template

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

generate by history requests

projects
required
Array of strings <uuid> (ULID)
countries
required
Array of strings <iso3166-alpha-2> (CountryAlpha2) [ items <iso3166-alpha-2 > = 2 characters ]
Items Enum: "AF" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CD" "CG" "CK" "CR" "HR" "CU" "CW" "CY" "CZ" "CI" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RO" "RU" "RW" "RE" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TM" "TC" "TV" "TR" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AX"
required
object (TabularDataPeriod)
required
Array of objects (GenerateTemplateCustomerMetadataFilter)
ignoreOperationPgp1526
boolean

Responses

Request samples

Content type
application/json
{
  • "projects": [
    ],
  • "period": {
    },
  • "countries": [
    ],
  • "customerMetadata": [
    ],
  • "ignoreOperationPgp1526": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "chains": [
    ],
  • "endpoints": {
    },
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "version": 0,
  • "reason": "string",
  • "createdAt": "2020-12-08T16:38:09.70516+03:00",
  • "updatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
  • "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "description": "string",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e"
}

List Templates Info

list templates info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Terminal

List Terminals

list terminals

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "terminals": [
    ]
}

Create Terminal

create terminal

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Terminal

config
required
object
integrationType
required
string (integrationType)
title
required
string [ 1 .. 100 ] characters
Array of objects (TerminalLabel)
object (processingLimits)
object (PaymentMethodsEnabled)
settings
object
currencyConversionsIds
Array of strings <uuid> (ULID)
kycEnabled
boolean
legalEntity
string
Array of objects (TerminalUnitConfig)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "integrationType": "string",
  • "labels": [
    ],
  • "title": "emulator",
  • "softLimits": {
    },
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "currencyConversionsIds": [
    ],
  • "kycEnabled": true,
  • "legalEntity": "string",
  • "unitsConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integrationType": "string",
  • "isActive": true,
  • "kycEnabled": true,
  • "labels": [
    ],
  • "currencyConversionsIds": [
    ],
  • "title": "emulator",
  • "legalEntity": "string",
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "config": {
    },
  • "unitsConfig": [
    ],
  • "softLimits": {
    },
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Update Terminal

update terminal

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Terminal ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update Terminal

config
required
object
isActive
required
boolean
title
required
string [ 1 .. 100 ] characters
object (processingLimits)
Array of objects (TerminalUnitConfig)
currencyConversionsIds
Array of strings <uuid> (ULID)
object (PaymentMethodsEnabled)
settings
object
kycEnabled
boolean
legalEntity
string
Array of objects (TerminalLabel)

Responses

Request samples

Content type
application/json
{
  • "config": {},
  • "softLimits": {
    },
  • "unitsConfig": [
    ],
  • "currencyConversionsIds": [
    ],
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "isActive": true,
  • "kycEnabled": true,
  • "legalEntity": "string",
  • "labels": [
    ],
  • "title": "emulator"
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integrationType": "string",
  • "isActive": true,
  • "kycEnabled": true,
  • "labels": [
    ],
  • "currencyConversionsIds": [
    ],
  • "title": "emulator",
  • "legalEntity": "string",
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "config": {
    },
  • "unitsConfig": [
    ],
  • "softLimits": {
    },
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Patch Terminal (isActive,kycEnabled)

patch terminal

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Terminal ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Patch Terminal (isActive,kycEnabled)

isActive
boolean or null (NullBoolean)
kycEnabled
boolean or null (NullBoolean)

Responses

Request samples

Content type
application/json
{
  • "isActive": true,
  • "kycEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integrationType": "string",
  • "isActive": true,
  • "kycEnabled": true,
  • "labels": [
    ],
  • "currencyConversionsIds": [
    ],
  • "title": "emulator",
  • "legalEntity": "string",
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "config": {
    },
  • "unitsConfig": [
    ],
  • "softLimits": {
    },
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Get Terminal Details

get terminal details

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Terminal ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "integrationType": "string",
  • "isActive": true,
  • "kycEnabled": true,
  • "labels": [
    ],
  • "currencyConversionsIds": [
    ],
  • "title": "emulator",
  • "legalEntity": "string",
  • "paymentMethodsEnabled": {
    },
  • "settings": { },
  • "config": {
    },
  • "unitsConfig": [
    ],
  • "softLimits": {
    },
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedAt": "2020-12-08T16:38:09.70516Z"
}

Terminal Labels

list all terminal labels

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ]
}

Add terminals currency conversions

add terminals currency conversions

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

terminalIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "terminalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Delete currency conversion from terminals

delete currency conversion from terminals

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

terminalIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "terminalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Update terminal's currency conversions

update currency conversions for а specific terminal

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

terminals currency conversion

currencyConversionIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "currencyConversionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

List Terminals Info

list terminals info

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "info": [
    ]
}

Patch Terminal project config (active)

patch terminal project config

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Terminal ID

terminalConfigUUid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Terminal Config ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Patch Terminal project config (active)

active
boolean or null (NullBoolean)

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Terminal Labels

Terminal Labels

list all terminal labels

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ]
}

Transaction

Transactions

list transactions

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "transactions": [
    ]
}

Transaction

get transaction by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Transaction ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ],
  • "transaction": {
    }
}

Create refund

Create a refund operation for the transaction

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Transaction ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
amount
required
string <= 20 characters
currencyCode
required
string <iso4217-currency-code> (currencyCode) [ 3 .. 7 ] characters
Enum: "AFN" "EUR" "ALL" "DZD" "USD" "AOA" "XCD" "ARS" "AMD" "AWG" "AUD" "AZN" "BSD" "BHD" "BDT" "BBD" "BYN" "BZD" "XOF" "BMD" "INR" "BTN" "BOB" "BOV" "BAM" "BWP" "NOK" "BRL" "BND" "BGN" "BIF" "CVE" "KHR" "XAF" "CAD" "KYD" "CLP" "CLF" "CNY" "COP" "COU" "KMF" "CDF" "NZD" "CRC" "CUP" "CUC" "ANG" "CZK" "DKK" "DJF" "DOP" "EGP" "SVC" "ERN" "SZL" "ETB" "FKP" "FJD" "XPF" "GMD" "GEL" "GHS" "GIP" "GTQ" "GBP" "GNF" "GYD" "HTG" "HNL" "HKD" "HUF" "ISK" "IDR" "IRR" "IQD" "ILS" "JMD" "JPY" "JOD" "KZT" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "ZAR" "LRD" "LYD" "CHF" "MOP" "MKD" "MGA" "MWK" "MYR" "MVR" "MRU" "MUR" "MXN" "MXV" "MDL" "MNT" "MAD" "MZN" "MMK" "NAD" "NPR" "NIO" "NGN" "OMR" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "PLN" "QAR" "RON" "RUB" "RWF" "SHP" "WST" "STN" "SAR" "RSD" "SCR" "SLE" "SGD" "SBD" "SOS" "SSP" "LKR" "SDG" "SRD" "SEK" "CHE" "CHW" "SYP" "TWD" "TJS" "TZS" "THB" "TOP" "TTD" "TND" "TRY" "TMT" "UGX" "UAH" "AED" "USN" "UYU" "UYI" "UYW" "UZS" "VUV" "VES" "VED" "VND" "YER" "ZMW" "ZWG" "XTS" "ADA" "APE" "ARB" "ATOM" "AVAX" "BCH" "BNB" "BNB-BSC" "BRZ" "BTC" "CRO" "CSC" "DAI" "DOGE" "ETH" "EURS" "HYPE" "LINK" "LTC" "MON" "OP" "OSMO" "PAXG" "POLYGON" "SAND" "SHIB" "SNACK" "SOL" "TON" "TRUMP" "TRX" "TWT" "UNI" "USDC" "USDCE" "USDT" "VERSE" "WBTC" "XAUT" "XED" "XRP"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currencyCode": "EUR"
}

Response samples

Content type
application/json
{
  • "operations": [
    ],
  • "transaction": {
    }
}

User

Users

list users

Authorizations:
BearerCookie
query Parameters
query
string

pgwql query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "cursor": { },
  • "fields": { },
  • "users": [
    ]
}

Create User

create user

Authorizations:
BearerCookie
header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create User

firstName
required
string [ 1 .. 70 ] characters
lastName
required
string [ 1 .. 70 ] characters
username
required
string <email>
phoneNumber
string
position
string [ 0 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "firstName": "Ivan",
  • "lastName": "Petrov",
  • "phoneNumber": 12345678912345,
  • "position": "manager",
  • "username": "[email protected]"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "firstName": "John",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "lastActiveAt": "2020-12-08T16:38:09.70516Z",
  • "lastName": "Connor",
  • "metadata": {
    },
  • "mfaType": "none",
  • "phoneNumber": "5432394302726",
  • "position": "manager",
  • "username": "[email protected]",
  • "superUserId": "84ad0a41-4e28-47e5-ab6c-171492b086ac"
}

User

get user by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ],
  • "unitAccessRights": [
    ],
  • "user": {
    },
  • "roles": [
    ]
}

Update User

update user

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update User

active
required
boolean
firstName
required
string [ 1 .. 70 ] characters
lastName
required
string [ 1 .. 70 ] characters
phoneNumber
string
position
string [ 0 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "firstName": "Ivan",
  • "lastName": "Petrov",
  • "phoneNumber": 12345678912345,
  • "position": "manager"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2020-12-08T16:38:09.70516Z",
  • "updatedAt": "2020-12-08T16:38:09.70516Z",
  • "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "updatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "firstName": "John",
  • "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "lastActiveAt": "2020-12-08T16:38:09.70516Z",
  • "lastName": "Connor",
  • "metadata": {
    },
  • "mfaType": "none",
  • "phoneNumber": "5432394302726",
  • "position": "manager",
  • "username": "[email protected]",
  • "superUserId": "84ad0a41-4e28-47e5-ab6c-171492b086ac"
}

Update user permissions

Update user permissions

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update user permissions

grant
Array of strings (permission)
Items Enum: "create-structural-unit" "update-structural-unit" "list-users" "create-user" "update-user" "reset-user-password" "reset-user-mfa" "update-user-permissions" "update-user-unit-access" "list-audit-logs" "list-integrations" "manage-integrations" "update-integration-name" "list-terminals" "create-terminal" "update-terminal" "list-templates" "create-template" "update-template" "manage-processing-settings" "list-transactions" "manage-transactions" "list-block-rules" "manage-block-rules" "list-velocity-rules" "manage-velocity-rules" "list-approval-rules" "manage-approval-rules" "list-kyc-rules" "manage-kyc-rules" "create-tokens" "manage-tokens" "list-customers" "update-customer" "list-customer-accounts" "update-customer-account" "merchant-operation-callback" "sync-operation" "view-analytics" "manage-analytics" "process-refund" "create-report" "list-reconciliations" "manage-reconciliations" "create-currency-conversion" "update-currency-conversion" "list-currency-conversions" "manage-errors" "poc-hidden-feature"
revoke
Array of strings (permission)
Items Enum: "create-structural-unit" "update-structural-unit" "list-users" "create-user" "update-user" "reset-user-password" "reset-user-mfa" "update-user-permissions" "update-user-unit-access" "list-audit-logs" "list-integrations" "manage-integrations" "update-integration-name" "list-terminals" "create-terminal" "update-terminal" "list-templates" "create-template" "update-template" "manage-processing-settings" "list-transactions" "manage-transactions" "list-block-rules" "manage-block-rules" "list-velocity-rules" "manage-velocity-rules" "list-approval-rules" "manage-approval-rules" "list-kyc-rules" "manage-kyc-rules" "create-tokens" "manage-tokens" "list-customers" "update-customer" "list-customer-accounts" "update-customer-account" "merchant-operation-callback" "sync-operation" "view-analytics" "manage-analytics" "process-refund" "create-report" "list-reconciliations" "manage-reconciliations" "create-currency-conversion" "update-currency-conversion" "list-currency-conversions" "manage-errors" "poc-hidden-feature"
grantRoles
Array of strings <uuid> (ULID)
revokeRoles
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "grant": [
    ],
  • "revoke": [
    ],
  • "grantRoles": [
    ],
  • "revokeRoles": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Update user structural unit access rights

Update user structural unit access rights

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

User ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Update user structural unit access rights

required
Array of objects (UnitAccessRecordRequest)
required
Array of objects (UnitAccessRecordRequest)

Responses

Request samples

Content type
application/json
{
  • "grant": [
    ],
  • "revoke": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

add role

Add role to users

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Role ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
userIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

delete role

Delete role from users

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Role ID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
userIds
required
Array of strings <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Widget

Get Widgets

get widgets

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "widgets": [
    ]
}

Create Widget

create widget

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Widget

tabId
required
string <uuid> (ULID)
title
required
string [ 1 .. 200 ] characters
required
object (WidgetConfig)
type
required
string (WidgetType)
Enum: "bar" "stackedBar" "pie" "doughnut" "histogram" "line" "table" "area"
required
object (WidgetView)

Responses

Request samples

Content type
application/json
{
  • "tabId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "type": "bar",
  • "config": {
    },
  • "view": {
    }
}

Response samples

Content type
application/json
{
  • "widget": {
    }
}

Create Batch Widgets

create batch widgets

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Create Batch Widgets

Array of objects (WidgetRequest)

Responses

Request samples

Content type
application/json
{
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Get Widget

get widget by id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

widgetUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "widget": {
    }
}

Update Widget

Update widget

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

widgetUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

update widget

tabId
required
string <uuid> (ULID)
title
required
string [ 1 .. 200 ] characters
required
object (WidgetConfig)
type
required
string (WidgetType)
Enum: "bar" "stackedBar" "pie" "doughnut" "histogram" "line" "table" "area"
required
object (WidgetView)

Responses

Request samples

Content type
application/json
{
  • "tabId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "title": "string",
  • "type": "bar",
  • "config": {
    },
  • "view": {
    }
}

Response samples

Content type
application/json
{
  • "widget": {
    }
}

Delete Widget

delete widget

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

widgetUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Move Widget

move widget

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

widgetUuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
tabId
required
string <uuid> (ULID)
dashboardId
required
string <uuid> (ULID)

Responses

Request samples

Content type
application/json
{
  • "tabId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
  • "dashboardId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "details": { }
}

Get Tabular Data

get tabular data by dashboard id

Authorizations:
BearerCookie
path Parameters
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

UUID

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json
widgetIds
Array of strings <uuid> (ULID)
object (TabularDataPeriod)
object (OverrideQuery)

Responses

Request samples

Content type
application/json
{
  • "widgetIds": [
    ],
  • "period": {
    },
  • "overrideQuery": {
    }
}

Response samples

Content type
application/json
{
  • "tabularData": {
    }
}

Preview Tabular Data

preview tabular data

Authorizations:
BearerCookie
query Parameters
dateFrom
string or null (NullTime)
Example: dateFrom=2020-12-08T16:38:09.70516Z

date from query

dateTo
string or null (NullTime)
Example: dateTo=2020-12-08T16:38:09.70516Z

date to query

timePeriod
string (Period)
Enum: "range" "today" "week" "month" "year" "weekTo" "monthTo" "yearTo" "15min" "30min" "1h" "4h" "12h" "24h" "7d" "30d" "60d" "90d" "1m" "6m" "1y" "2y" "5y"

date to query

timePeriodField
string (DateIntervalParameter)
Enum: "createdAt" "updatedAt"

date field to query

timezone
string <rfc6557-time-zone> (Timezone)
Example: timezone=Europe/Minsk

date to query

header Parameters
x-merchant-id
required
string [ 1 .. 100 ] characters

Merchant short ID, provided to you by the FinteqHub team.

x-fingerprint
required
string = 32 characters

Fingerprint

x-request-id
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0

Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

Preview Tabular Data

required
object (WidgetQuery)

Responses

Request samples

Content type
application/json
{
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "tabularData": [
    ]
}