docs-backoffice.staging.pgw.baby
Open in
urlscan Pro
2606:4700:3030::6815:6001
Public Scan
URL:
https://docs-backoffice.staging.pgw.baby/
Submission: On December 06 via api from US — Scanned from DE
Submission: On December 06 via api from US — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* AuditLog
* getGet audit log
* Auth
* postLogin
* postLogout
* getGetTotpBarcode
* postCheckMfaCode
* delResetMFA
* postUpdatePassword
* postCheckResetPasswordToken
* postUpdateResetPassword
* postResetPassword
* getSession
* Block Rule
* getList all Block Rules
* postCreate Block Rule
* getList Latest Block Rules
* getGet latest Block Rule
* putUpdate Block Rule
* delDelete Block Rule
* getlist all versions for Block Rule
* Config
* getapplication config
* Currency Conversion
* postCreate currency conversion
* postUpdate currency conversion
* getGet latest currency conversion version
* delDelete currency conversion
* getList latest currency conversions
* getList all versions for currency conversion
* postAdd terminals currency conversions
* delDelete currency conversion from terminals
* patchUpdate terminal's currency conversions
* Customer
* getCustomers
* getCustomers
* patchUpdate Customer
* getCustomer Accounts
* getCustomer customer accounts
* getCustomer account
* patchUpdate customer account
* Customer Accounts
* getCustomer Accounts
* Customer accounts
* getCustomer customer accounts
* getCustomer account
* patchUpdate customer account
* Dashboard
* getdashboards
* postCreate dashboards
* getDashboard
* putUpdate Dashboard
* delDelete Dashboard
* postUpdate Dashboard Widgets View
* postGet Tabular Data
* Dictionaries
* getGet card issuers
* getGet terminal config
* getGet merchant payments config
* getGet reconciliation integrations
* Integration
* getList Integrations
* putUpdate Integration
* getGet Integration Details
* Merchant
* putUpdate Merchant
* Operations
* getList operations
* getGet operation
* patchCheck operation status
* patchCheck operation status
* Project
* postCreate Project
* putUpdate Project
* patchUpdate Project Scenarios
* getGet Payment Methods
* postAdd Projects Scenario
* delDelete Projects Scenario
* ProjectGroup
* postCreate Project Group
* putUpdate Project Group
* ProjectTokens
* getGet Project Tokens
* postCreate Project Tokens
* getGet Project Token
* putUpdate Project Token
* patchDeactivate Project Token
* Reconciliation
* getRetrieve reconciled operations
* getRetrieve reconciliation aggregates
* postMark reconciled operation as confirmed
* getRetrieve all reconciliation reports for user
* postCreate reconciliation report
* getRetrieve reconciliation report with download link for user
* postUpload integration operations file
* postProcess uploaded integration operations file
* Transaction Report
* getGet Transaction Reports
* postCreate Transaction Report
* getDownload Transaction Report
* Scenario
* getList Scenarios
* postCreate Scenario
* getList Latest Scenarios
* putUpdate Scenario
* getGet latest scenario
* delDelete Scenario
* getlist all versions for scenario
* Text Search
* getSearch Text In Field In Customers
* getSearch Text In Field In Operations
* StructuralUnits
* getGet Merchant Structural Units Hierarchy
* Template
* getList all templates
* postCreate Template
* getList Latest Templates
* getGet latest template
* putUpdate Template
* getlist all versions for template
* postGenerate new template
* Terminal
* getList Terminals
* postCreate Terminal
* putUpdate Terminal
* patchActivate/Deactivate Terminal
* getGet Terminal Details
* getTerminal Labels
* postAdd terminals currency conversions
* delDelete currency conversion from terminals
* patchUpdate terminal's currency conversions
* Terminal Labels
* getTerminal Labels
* Transaction
* getTransactions
* getTransaction
* postCreate refund
* User
* getUsers
* postCreate User
* getUser
* putUpdate User
* patchUpdate user permissions
* patchUpdate user structural unit access rights
* Widget
* getGet Widgets
* postCreate Widget
* postCreate Batch Widgets
* getGet Widget
* putUpdate Widget
* delDelete Widget
* postGet Tabular Data
* postPreview Tabular Data
API docs by Redocly
FINTEQHUB BACKOFFICE API REFERENCE
Download OpenAPI specification:Download
AUDITLOG
GET AUDIT LOG
get audit log by user 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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/audit/{uuid}
/v1/audit/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "logs": [
* {
* "at": "2020-12-08T16:38:09.70516+03:00",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "saga": "CreateUser",
* "sagaId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "sessionId": "s.utnmgOPwTF8elMkPM5DBCBN7",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": { },
* "entityIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
]
}
AUTH
LOGIN
login
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
403
Forbidden
408
Request timeout
500
Server error
post/auth/login
/v1/auth/login
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "password": "password",
* "username": "user@email.com"
}
RESPONSE SAMPLES
* 200
* 400
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "lastActiveAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": {
* "merchant": "softswiss",
* "username": "angelinajolie@softswiss.com"
},
* "mfa": {
* "linked": true,
* "passed": true,
* "type": "none"
},
* "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"
}
LOGOUT
logout
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/auth/logout
/v1/auth/logout
RESPONSE SAMPLES
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
GETTOTPBARCODE
get totp png base64 image
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/auth/totp
/v1/auth/totp
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/auth/mfa
/v1/auth/mfa
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "code": "123456"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "lastActiveAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": {
* "merchant": "softswiss",
* "username": "angelinajolie@softswiss.com"
},
* "mfa": {
* "linked": true,
* "passed": true,
* "type": "none"
},
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/auth/mfa/{uuid}
/v1/auth/mfa/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
UPDATEPASSWORD
update user password
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/auth/password
/v1/auth/password
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "oldPassword": "password",
* "newPassword": "password2"
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
CHECKRESETPASSWORDTOKEN
check user reset password token
AUTHORIZATIONS:
PasswordResetToken
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
408
Request timeout
500
Server error
post/auth/password-reset-token
/v1/auth/password-reset-token
RESPONSE SAMPLES
* 400
* 401
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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 password when it is reset or create new password after registration
newPassword
required
string [ 8 .. 32 ] characters
RESPONSES
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/auth/update-reset-password
/v1/auth/update-reset-password
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "newPassword": "password2"
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/auth/reset-password/{uuid}
/v1/auth/reset-password/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
SESSION
Session
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/auth/session
/v1/auth/session
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "permissions": [
* "string"
],
* "session": {
* "lastActiveAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": {
* "merchant": "softswiss",
* "username": "angelinajolie@softswiss.com"
},
* "mfa": {
* "linked": true,
* "passed": true,
* "type": "none"
},
* "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"
},
* "unitAccessRights": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "level": "ro",
* "inherited": true
}
],
* "user": {
* "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": {
* "permissionCount": 0,
* "projectCount": 0
},
* "mfaType": "none",
* "phoneNumber": "5432394302726",
* "position": "manager",
* "username": "root@example.com"
}
}
BLOCK RULE
LIST ALL BLOCK RULES
list all block rules
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/block-rules
/v1/block-rules
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRules": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
CREATE BLOCK RULE
create block rule
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
chains
required
Array of objects (Chain)
endpoints
required
object
title
required
string [ 5 .. 100 ] characters
active
boolean
description
string <= 250 characters
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/block-rules
/v1/block-rules
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "title": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRule": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
}
LIST LATEST BLOCK RULES
list latest block rules
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/block-rules/latest
/v1/block-rules/latest
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRules": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
GET LATEST BLOCK RULE
get latest 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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/block-rules/{uuid}
/v1/block-rules/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRule": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
UPDATE BLOCK RULE
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 [ 5 .. 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
chains
required
Array of objects (Chain)
endpoints
required
object
title
required
string [ 5 .. 100 ] characters
id
required
string <uuid> (ULID)
active
boolean
description
string <= 250 characters
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/block-rules/{uuid}
/v1/block-rules/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRule": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
}
DELETE BLOCK RULE
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/block-rules/{uuid}
/v1/block-rules/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/block-rules/{uuid}/versions
/v1/block-rules/{uuid}/versions
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "blockRules": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "actions": [
* {
* "type": "blockOperation",
* "value": "string"
}
]
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
CONFIG
APPLICATION CONFIG
application config
RESPONSES
200
OK
get/config
/v1/config
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "release": "v1.0.0"
}
CURRENCY CONVERSION
CREATE CURRENCY CONVERSION
create currency conversion
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
config
required
object (CurrencyConversionConfig)
description
string <= 250 characters
active
boolean
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/currency-conversions
/v1/currency-conversions
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "description": "string",
* "active": true,
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string",
* "version": 0,
* "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": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
UPDATE CURRENCY CONVERSION
update 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 [ 5 .. 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
config
required
object (CurrencyConversionConfig)
description
string <= 250 characters
active
boolean
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/currency-conversions/{uuid}
/v1/currency-conversions/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "description": "string",
* "active": true,
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string",
* "version": 0,
* "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": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
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
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/currency-conversions/{uuid}
/v1/currency-conversions/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string",
* "version": 0,
* "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": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
DELETE CURRENCY CONVERSION
delete 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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/currency-conversions/{uuid}
/v1/currency-conversions/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
LIST LATEST CURRENCY CONVERSIONS
list latest currency conversions
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/currency-conversions/latest
/v1/currency-conversions/latest
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "currencyConversions": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string",
* "version": 0,
* "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": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/currency-conversions/{uuid}/versions
/v1/currency-conversions/{uuid}/versions
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "currencyConversion": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string",
* "version": 0,
* "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": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
}
},
* "versions": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "config": {
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
],
* "action": {
* "targetCurrency": "EUR"
}
},
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
]
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/terminals/currency-conversions/{uuid}
/v1/terminals/currency-conversions/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "terminalIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/terminals/currency-conversions/{uuid}
/v1/terminals/currency-conversions/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "terminalIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/terminals/{uuid}/currency-conversions
/v1/terminals/{uuid}/currency-conversions
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "currencyConversionIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
CUSTOMER
CUSTOMERS
list customers
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/customers
/v1/customers
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "customers": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantCustomerId": "string",
* "active": true,
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "name": "John Doe",
* "countryCode": "AS",
* "email": "string",
* "phoneNumber": "string",
* "birthDate": "string",
* "metadata": { }
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/customers/{uuid}
/v1/customers/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customer": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantCustomerId": "string",
* "active": true,
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "name": "John Doe",
* "countryCode": "AS",
* "email": "string",
* "phoneNumber": "string",
* "birthDate": "string",
* "metadata": { }
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/customers/{uuid}
/v1/customers/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "active": true
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customer": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantCustomerId": "string",
* "active": true,
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "name": "John Doe",
* "countryCode": "AS",
* "email": "string",
* "phoneNumber": "string",
* "birthDate": "string",
* "metadata": { }
}
}
CUSTOMER ACCOUNTS
list all customer accounts
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/customers/accounts
/v1/customers/accounts
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "customersAccounts": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/customers/{uuid}/customer-accounts
/v1/customers/{uuid}/customer-accounts
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "customersAccounts": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/customers/{uuid}/customer-accounts/{accountUuid}
/v1/customers/{uuid}/customer-accounts/{accountUuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customerAccount": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
}
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 [ 5 .. 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" "expired"
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/customers/{uuid}/customer-accounts/{accountUuid}
/v1/customers/{uuid}/customer-accounts/{accountUuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "blockReason": "Blocked by customer",
* "status": "new"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customerAccount": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
}
CUSTOMER ACCOUNTS
CUSTOMER ACCOUNTS
list all customer accounts
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/customers/accounts
/v1/customers/accounts
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "customersAccounts": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/customers/{uuid}/customer-accounts
/v1/customers/{uuid}/customer-accounts
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "customersAccounts": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/customers/{uuid}/customer-accounts/{accountUuid}
/v1/customers/{uuid}/customer-accounts/{accountUuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customerAccount": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
}
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 [ 5 .. 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" "expired"
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/customers/{uuid}/customer-accounts/{accountUuid}
/v1/customers/{uuid}/customer-accounts/{accountUuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "blockReason": "Blocked by customer",
* "status": "new"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "customerAccount": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationAccountId": "string",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "paymentMethod": "alfabank",
* "status": "new",
* "successAttempts": 0,
* "unsuccessfulAttempts": 0,
* "blockReason": "Blocked by customer",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "metadata": { }
}
}
DASHBOARD
DASHBOARDS
list dashboards
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/dashboards
/v1/dashboards
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "dashboards": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
],
* "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",
* "widgetCount": 0
}
]
}
CREATE DASHBOARDS
create dashboard
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
filters
Array of objects (DashboardFilter)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/dashboards
/v1/dashboards
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "dashboard": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
],
* "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"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/dashboards/{uuid}
/v1/dashboards/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "dashboard": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
],
* "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 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 [ 5 .. 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
filters
Array of objects (DashboardFilter)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/dashboards/{uuid}
/v1/dashboards/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "dashboard": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "filters": [
* {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
],
* "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 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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/dashboards/{uuid}
/v1/dashboards/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
view
required
object (DashboardView)
RESPONSES
200
success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/{uuid}/view
/v1/dashboards/{uuid}/view
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "view": {
* "property1": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
},
* "property2": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
}
}
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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)
period
object (TabularDataPeriod)
overrideQuery
object (OverrideQuery)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/{uuid}/widgets/tabular-data
/v1/dashboards/{uuid}/widgets/tabular-data
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "widgetIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "tabularData": {
* "property1": "string",
* "property2": "string"
}
}
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
200
OK
400
Invalid request
500
Server error
get/dictionaries/card-issuers
/v1/dictionaries/card-issuers
RESPONSE SAMPLES
* 200
* 400
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "items": [
* "string"
]
}
GET TERMINAL CONFIG
get terminal config
QUERY PARAMETERS
integrationType
required
string (integrationType)
Enum: "astropay" "directa-24" "ecopayz" "emulator" "ezeewallet" "neosurf" "none"
"payzen" "skrill" "klarna" "yoomoney" "paysafecard" "card-acquirer" "tranzzo"
"sofort" "interac" "skinsback" "paycos" "eurobankpartners" "brite" "paysafe"
"yoomoney-bankcard" "emerchantpay" "paymentiq" "global-transaction-charge"
"billline" "payabl" "certus" "mpay" "dasshpe" "volt" "impaya" "inpay" "noda"
"paybrokers" "zenetpay" "gumballpay" "pay-5" "mandato" "peachpayments"
"mr-payments" "paypositive" "adamas" "canapay" "antrpay" "aps" "latpay" "isx"
"kyrenpay" "monetix" "vivawallet" "kitopay" "paycord" "bigidea" "checkout"
"crederes" "settlepay" "expefast" "payper" "epay" "ivy" "dns" "finshark"
"mifinity" "allsecure" "callpay" "kasha" "muchbetter" "ari-10" "contiant"
"utorg" "ozow" "tunzer" "rapyd" "flexify" "kaktus" "pay4fun" "sends" "flexo"
"royalpay"
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
200
OK
400
Invalid request
500
Server error
get/dictionaries/terminal-config
/v1/dictionaries/terminal-config
RESPONSE SAMPLES
* 200
* 400
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "properties": {
* "credentials": {
* "properties": {
* "global": {
* "properties": {
* "property1": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* "string"
],
* "items": {
* "type": "string",
* "enum": [
* "string"
]
}
},
* "property2": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* "string"
],
* "items": {
* "type": "string",
* "enum": [
* "string"
]
}
}
},
* "x-validation": {
* "property1": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
},
* "property2": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
}
}
},
* "perTransactionType": {
* "properties": {
* "deposit": {
* "properties": {
* "property1": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
},
* "property2": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
}
},
* "x-validation": {
* "property1": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
},
* "property2": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
}
}
},
* "withdrawal": {
* "properties": {
* "property1": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
},
* "property2": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
}
},
* "x-validation": {
* "property1": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
},
* "property2": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
}
}
}
}
},
* "perPaymentMethod": {
* "properties": {
* "property1": {
* "properties": {
* "property1": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
},
* "property2": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
}
},
* "x-validation": {
* "property1": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
},
* "property2": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
}
}
},
* "property2": {
* "properties": {
* "property1": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
},
* "property2": {
* "type": "string",
* "format": "string",
* "default": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0,
* "description": "string",
* "title": "string",
* "secret": true,
* "textarea": true,
* "enum": [
* null
],
* "items": {
* "type": null,
* "enum": [ ]
}
}
},
* "x-validation": {
* "property1": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
},
* "property2": {
* "required": true,
* "format": "string",
* "maxLength": 0,
* "minLength": 0,
* "minimum": 0,
* "maximum": 0
}
}
}
}
}
}
}
}
}
GET MERCHANT PAYMENTS CONFIG
get merchant payments config
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/dictionaries/integrations
/v1/dictionaries/integrations
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "integrations": {
* "property1": {
* "friendlyName": "string",
* "logo": "string"
},
* "property2": {
* "friendlyName": "string",
* "logo": "string"
}
},
* "paymentMethods": {
* "property1": {
* "friendlyName": "string",
* "logo": "string"
},
* "property2": {
* "friendlyName": "string",
* "logo": "string"
}
}
}
GET RECONCILIATION INTEGRATIONS
get reconciliation integrations
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/dictionaries/reconciliation-integrations
/v1/dictionaries/reconciliation-integrations
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "integrations": {
* "property1": {
* "title": "string",
* "manualUpload": true,
* "paymentMethods": {
* "property1": "string",
* "property2": "string"
},
* "sources": [
* {
* "source": "isx_bank_report",
* "title": "string"
}
]
},
* "property2": {
* "title": "string",
* "manualUpload": true,
* "paymentMethods": {
* "property1": "string",
* "property2": "string"
},
* "sources": [
* {
* "source": "isx_bank_report",
* "title": "string"
}
]
}
}
}
INTEGRATION
LIST INTEGRATIONS
list integrations
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/integrations
/v1/integrations
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "integrations": [
* {
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "isActive": true,
* "title": "PayPal",
* "type": "astropay",
* "paymentMethodsByTransaction": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
},
* "hardLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "updatedAt": "2020-12-08T16:38:09.70516Z"
}
]
}
UPDATE INTEGRATION
update integration
AUTHORIZATIONS:
BearerCookie
PATH PARAMETERS
name
required
string (integrationType)
Enum: "astropay" "directa-24" "ecopayz" "emulator" "ezeewallet" "neosurf" "none"
"payzen" "skrill" "klarna" "yoomoney" "paysafecard" "card-acquirer" "tranzzo"
"sofort" "interac" "skinsback" "paycos" "eurobankpartners" "brite" "paysafe"
"yoomoney-bankcard" "emerchantpay" "paymentiq" "global-transaction-charge"
"billline" "payabl" "certus" "mpay" "dasshpe" "volt" "impaya" "inpay" "noda"
"paybrokers" "zenetpay" "gumballpay" "pay-5" "mandato" "peachpayments"
"mr-payments" "paypositive" "adamas" "canapay" "antrpay" "aps" "latpay" "isx"
"kyrenpay" "monetix" "vivawallet" "kitopay" "paycord" "bigidea" "checkout"
"crederes" "settlepay" "expefast" "payper" "epay" "ivy" "dns" "finshark"
"mifinity" "allsecure" "callpay" "kasha" "muchbetter" "ari-10" "contiant"
"utorg" "ozow" "tunzer" "rapyd" "flexify" "kaktus" "pay4fun" "sends" "flexo"
"royalpay"
Integration type
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/integrations/{name}
/v1/integrations/{name}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "isActive": true
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "isActive": true,
* "title": "PayPal",
* "type": "astropay",
* "paymentMethodsByTransaction": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
},
* "hardLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "updatedAt": "2020-12-08T16:38:09.70516Z"
}
GET INTEGRATION DETAILS
get integration details
AUTHORIZATIONS:
BearerCookie
PATH PARAMETERS
name
required
string (integrationType)
Enum: "astropay" "directa-24" "ecopayz" "emulator" "ezeewallet" "neosurf" "none"
"payzen" "skrill" "klarna" "yoomoney" "paysafecard" "card-acquirer" "tranzzo"
"sofort" "interac" "skinsback" "paycos" "eurobankpartners" "brite" "paysafe"
"yoomoney-bankcard" "emerchantpay" "paymentiq" "global-transaction-charge"
"billline" "payabl" "certus" "mpay" "dasshpe" "volt" "impaya" "inpay" "noda"
"paybrokers" "zenetpay" "gumballpay" "pay-5" "mandato" "peachpayments"
"mr-payments" "paypositive" "adamas" "canapay" "antrpay" "aps" "latpay" "isx"
"kyrenpay" "monetix" "vivawallet" "kitopay" "paycord" "bigidea" "checkout"
"crederes" "settlepay" "expefast" "payper" "epay" "ivy" "dns" "finshark"
"mifinity" "allsecure" "callpay" "kasha" "muchbetter" "ari-10" "contiant"
"utorg" "ozow" "tunzer" "rapyd" "flexify" "kaktus" "pay4fun" "sends" "flexo"
"royalpay"
Integration type
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/integrations/{name}
/v1/integrations/{name}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "isActive": true,
* "title": "PayPal",
* "type": "astropay",
* "paymentMethodsByTransaction": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
},
* "hardLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "updatedAt": "2020-12-08T16:38:09.70516Z"
}
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 [ 5 .. 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
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/merchant/{uuid}
/v1/merchant/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "active": true,
* "businessContact": "Business Contact",
* "description": "some text",
* "technicalContact": "Technical Contact",
* "title": "Merchant title",
* "operationAmountRoundType": "up"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
{
* "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"
}
OPERATIONS
LIST OPERATIONS
list operations
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/operations
/v1/operations
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "operations": [
* {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "flow": "direct",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationOperationId": "string",
* "integrationAccountId": "string",
* "integrationStatusCode": "string",
* "integrationType": "astropay",
* "integrationTitle": "string",
* "merchantOperationId": "string",
* "credentials": { },
* "metadata": { },
* "info": { },
* "customerInfo": {
* "email": "string",
* "merchantCustomerId": "string",
* "metadata": { }
},
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "cancelled",
* "terminalId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "terminalTitle": "string",
* "transactionId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "transactionType": "deposit",
* "type": "charge",
* "paymentMethodType": "alfabank",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",
* "userCountryCode": "AS",
* "paymentInstrument": [
* "string"
],
* "finalizationDate": "2020-12-08T16:38:09.70516Z"
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/operations/{uuid}
/v1/operations/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "operation": {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "flow": "direct",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationOperationId": "string",
* "integrationStatusCode": "string",
* "integrationType": "astropay",
* "integrationTitle": "string",
* "merchantOperationId": "string",
* "credentials": { },
* "metadata": { },
* "info": { },
* "customerInfo": {
* "email": "string",
* "merchantCustomerId": "string",
* "metadata": { }
},
* "paymentInstrument": [
* "string"
],
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "cancelled",
* "terminalId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "transactionId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "charge",
* "paymentMethodType": "alfabank",
* "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",
* "finalizationDate": "2020-12-08T16:38:09.70516Z"
},
* "operationLogs": [
* {
* "operationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "status_changed",
* "at": "2020-12-08T16:38:09.70516Z",
* "metadata": {
* "formUrl": "string",
* "reason": "string"
}
}
],
* "operationCommunicationLogs": [
* {
* "count": 0,
* "type": "integration_callback",
* "operationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "requestUrl": "string",
* "requestBody": "string",
* "at": "2020-12-08T16:38:09.70516Z",
* "statusCode": 0,
* "body": "string",
* "error": "string"
}
]
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/operations/{uuid}/status
/v1/operations/{uuid}/status
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/operations/{uuid}/{jobType}
/v1/operations/{uuid}/{jobType}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
PROJECT
CREATE PROJECT
create project
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
integrationUrl
required
string <uri> (HttpURL)
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)
successUrl
string <uri> (NullHttpURL)
config
string
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/projects
/v1/projects
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "description": "project description",
* "failUrl": "http(s)://google.com",
* "integrationUrl": "http(s)://google.com",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "successUrl": "http(s)://google.com",
* "title": "Project Group title",
* "timezone": "Europe/Minsk",
* "config": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "integrationUrl": "http(s)://google.com",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "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",
* "config": "string"
}
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 [ 5 .. 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)
integrationUrl
required
string <uri> (HttpURL)
description
string <= 200 characters
failUrl
string <uri> (NullHttpURL)
successUrl
string <uri> (NullHttpURL)
config
string
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/projects/{uuid}
/v1/projects/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "active": true,
* "description": "project description",
* "failUrl": "http(s)://google.com",
* "integrationUrl": "http(s)://google.com",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "successUrl": "http(s)://google.com",
* "title": "Project Group title",
* "timezone": "Europe/Minsk",
* "config": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "integrationUrl": "http(s)://google.com",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "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",
* "config": "string"
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/projects/{uuid}/scenarios
/v1/projects/{uuid}/scenarios
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "projectScenarios": [
* {
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
]
}
GET PAYMENT METHODS
get payment methods by transaction type
AUTHORIZATIONS:
BearerCookie
PATH PARAMETERS
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0
UUID
QUERY PARAMETERS
txtype
required
string (transactionType)
Enum: "deposit" "withdrawal"
Transaction type
currencyCode
string <iso4217-currency-code> (CurrencyCode) = 3 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"
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
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/projects/{uuid}/payment-methods
/v1/projects/{uuid}/payment-methods
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "availableMethods": {
* "property1": [
* "astropay"
],
* "property2": [
* "astropay"
]
}
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/projects/scenarios/{uuid}
/v1/projects/scenarios/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "projectIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "prepend": true
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "projectScenarios": [
* {
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
]
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/projects/scenarios/{uuid}
/v1/projects/scenarios/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "projectIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "projectScenarios": [
* {
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
]
}
PROJECTGROUP
CREATE PROJECT GROUP
create project group
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/project-groups
/v1/project-groups
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "Project Group title",
* "description": "Project Group description"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/project-groups/{uuid}
/v1/project-groups/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "active": true,
* "description": "some text",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "Project Group title"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/projects/{uuid}/tokens
/v1/projects/{uuid}/tokens
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "tokens": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "token name",
* "active": true,
* "expireAt": "2020-12-08T16:38:09.70516+03:00",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": 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"
}
]
}
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 [ 5 .. 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 Token
title
required
string [ 1 .. 200 ] characters
expireAt
required
string or null (NullTime)
claims
required
object (ProjectTokenClaims)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/projects/{uuid}/tokens
/v1/projects/{uuid}/tokens
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "token name",
* "expireAt": "2020-12-08T16:38:09.70516Z",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": true
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "token name",
* "active": true,
* "expireAt": "2020-12-08T16:38:09.70516+03:00",
* "token":
"badcafebadc0ffeebadbabebadf00d0000badcafebadc0ffeebadbabebadf00dbadcafebadc0ffeebadbabebadf00d0000badcafebadc0ffeebadbabebadf00d",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": 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"
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/projects/{uuid}/tokens/{tokenUuid}
/v1/projects/{uuid}/tokens/{tokenUuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "token name",
* "active": true,
* "expireAt": "2020-12-08T16:38:09.70516+03:00",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": 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"
}
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 [ 5 .. 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 token
title
required
string
claims
required
object (ProjectTokenClaims)
expireAt
required
string or null (NullTime)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/projects/{uuid}/tokens/{tokenUuid}
/v1/projects/{uuid}/tokens/{tokenUuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "token name",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": true
},
* "expireAt": "2020-12-08T16:38:09.70516Z"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "token name",
* "active": true,
* "expireAt": "2020-12-08T16:38:09.70516+03:00",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": 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"
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/projects/{uuid}/tokens/{tokenUuid}
/v1/projects/{uuid}/tokens/{tokenUuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "token name",
* "active": true,
* "expireAt": "2020-12-08T16:38:09.70516+03:00",
* "claims": {
* "initTransaction": {
* "txTypes": [
* "deposit"
],
* "currencies": [
* {
* "code": "EUR",
* "maxAmount": "string"
}
]
},
* "reconciliations": true,
* "listOperations": 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"
}
RECONCILIATION
RETRIEVE RECONCILED OPERATIONS
Retrieve reconciled operations
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/reconciliations/records
/v1/reconciliations/records
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "reconciliations": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "finteqhubOperationId": "string",
* "merchantOperationId": "string",
* "integrationOperationId": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "updatedAt": "2019-08-24T14:15:22Z",
* "operationCreatedAt": "2019-08-24T14:15:22Z",
* "projectGroupIds": [
* "497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
* "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
* "paymentInstruments": [
* "string"
],
* "paymentMethod": "string",
* "integration": "string",
* "merchantAmount": 0,
* "merchantAmountInEUR": 0,
* "merchantCurrencyCode": "EUR",
* "merchantTransactionType": "deposit",
* "merchantOperationType": "charge",
* "merchantStatus": "processing",
* "merchantFinalizedAt": "2019-08-24T14:15:22Z",
* "integrationAmount": 0,
* "integrationAmountInEUR": 0,
* "integrationCurrencyCode": "EUR",
* "integrationTransactionType": "deposit",
* "integrationOperationType": "charge",
* "integrationStatus": "processing",
* "integrationFinalizedAt": "2019-08-24T14:15:22Z",
* "pgwAmount": 0,
* "pgwAmountInEUR": 0,
* "pgwCurrencyCode": "EUR",
* "pgwInitialAmount": 0,
* "pgwInitialCurrencyCode": "EUR",
* "pgwTransactionType": "deposit",
* "pgwOperationType": "charge",
* "pgwStatus": "processing",
* "referenceId": "string",
* "isConsistent": true,
* "forceConsistent": true,
* "comment": "string",
* "inconsistencyTypes": [
* "missing ID"
],
* "withPgw": true
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/reconciliations/aggregates
/v1/reconciliations/aggregates
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "groups": [
* {
* "spec": {
* "type": "integration",
* "title": "string"
},
* "info": {
* "totalCount": 0,
* "inconsistentCount": 0,
* "inconsistentPercent": 0,
* "hasNonPgwOperations": true
},
* "amounts": {
* "initialPgw": 0,
* "pgw": 0,
* "integration": 0,
* "merchant": 0
},
* "amountsInEUR": {
* "pgw": 0,
* "integration": 0,
* "merchant": 0
},
* "subgroups": [
* { }
]
}
],
* "totals": {
* "hasNonPgwOperations": true,
* "inconsistentCount": 0,
* "amountsInEUR": {
* "pgw": 0,
* "integration": 0,
* "merchant": 0
}
}
}
MARK RECONCILED OPERATION AS CONFIRMED
Mark reconciled operation as confirmed
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/reconciliations/confirmations
/v1/reconciliations/confirmations
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "query": "string",
* "forceConsistent": true,
* "comment": "string"
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
RETRIEVE ALL RECONCILIATION REPORTS FOR USER
Retrieve all reconciliation reports for user
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/reconciliations/reports
/v1/reconciliations/reports
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "reports": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "status": "in_progress",
* "createdAt": "2019-08-24T14:15:22Z",
* "updatedAt": "2019-08-24T14:15:22Z",
* "error": "string"
}
]
}
CREATE RECONCILIATION REPORT
Create reconciliation report
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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"
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/reconciliations/reports
/v1/reconciliations/reports
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "query": "string",
* "groups": [
* "integration"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
{
* "reportID": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "in_progress"
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/reconciliations/reports/{uuid}
/v1/reconciliations/reports/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "report": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "status": "in_progress",
* "createdAt": "2019-08-24T14:15:22Z",
* "updatedAt": "2019-08-24T14:15:22Z",
* "error": "string",
* "url": "http(s)://google.com"
}
}
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 [ 5 .. 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
201
Created
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/reconciliations/files
/v1/reconciliations/files
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
{
* "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 [ 5 .. 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 (lavanderiaIntegrationType)
Enum: "crederes" "noda" "impaya" "aps" "contiant" "payabl" "utorg" "concryt"
"mandato"
source
required
string (lavanderiaFileSourceType)
Enum: "isx_bank_report" "impaya_report" "utorg_report"
RESPONSES
204
Processed
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/reconciliations/integration-operations
/v1/reconciliations/integration-operations
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "fileId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integration": "crederes",
* "source": "isx_bank_report"
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
TRANSACTION REPORT
GET TRANSACTION REPORTS
get transaction reports
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/reports
/v1/reports
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "reports": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "status": "in_progress",
* "config": {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516+03:00",
* "dateTo": "2020-12-08T16:38:09.70516+03:00",
* "periodField": "operation_created_at"
},
* "fields": [
* "operation_id"
],
* "filters": [
* {
* "field": "project_id",
* "value": [
* "string"
]
}
]
},
* "created_by": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "error": "string"
}
]
}
CREATE TRANSACTION REPORT
create transaction report
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
config
required
object (TransactionReportConfig)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/reports
/v1/reports
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "config": {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516+03:00",
* "dateTo": "2020-12-08T16:38:09.70516+03:00",
* "periodField": "operation_created_at"
},
* "fields": [
* "operation_id"
],
* "filters": [
* {
* "field": "project_id",
* "value": [
* "string"
]
}
]
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "report": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "createdAt": "2020-12-08T16:38:09.70516+03:00",
* "updatedAt": "2020-12-08T16:38:09.70516+03:00",
* "status": "in_progress",
* "config": {
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516+03:00",
* "dateTo": "2020-12-08T16:38:09.70516+03:00",
* "periodField": "operation_created_at"
},
* "fields": [
* "operation_id"
],
* "filters": [
* {
* "field": "project_id",
* "value": [
* "string"
]
}
]
},
* "created_by": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "error": "string"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/reports/{uuid}/download
/v1/reports/{uuid}/download
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
{
* "url": "string"
}
SCENARIO
LIST SCENARIOS
list 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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/structural-unit/{unitId}/scenarios
/v1/structural-unit/{unitId}/scenarios
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenarios": [
* {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
]
}
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 [ 5 .. 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
mask
required
object (Mask)
templateId
required
string <uuid> (ULID)
active
boolean
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/structural-unit/{unitId}/scenarios
/v1/structural-unit/{unitId}/scenarios
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
}
},
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenario": {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/structural-unit/{unitId}/scenarios/latest
/v1/structural-unit/{unitId}/scenarios/latest
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenarios": [
* {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
]
}
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 [ 5 .. 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
mask
required
object (Mask)
active
required
boolean
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/structural-unit/{unitId}/scenarios/{uuid}
/v1/structural-unit/{unitId}/scenarios/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
}
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenario": {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/structural-unit/{unitId}/scenarios/{uuid}
/v1/structural-unit/{unitId}/scenarios/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenario": {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/structural-unit/{unitId}/scenarios/{uuid}
/v1/structural-unit/{unitId}/scenarios/{uuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/structural-unit/{unitId}/scenarios/{uuid}/versions
/v1/structural-unit/{unitId}/scenarios/{uuid}/versions
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "scenarios": [
* {
* "active": true,
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "mask": {
* "chains": {
* "property1": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
},
* "property2": {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
},
* "rules": {
* "property1": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
},
* "property2": {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
},
* "applicable": true
},
* "structuralUnitId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "templateId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "version": 0,
* "versionCreatedAt": "2020-12-08T16:38:09.70516+03:00",
* "versionCreatedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "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"
}
]
}
TEXT SEARCH
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/customer-events/search
/v1/customer-events/search
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "items": [
* "string"
]
}
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"
search field
text
required
string >= 2 characters
text to search in field
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/operation-events/search
/v1/operation-events/search
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "items": [
* "string"
]
}
STRUCTURALUNITS
GET MERCHANT STRUCTURAL UNITS HIERARCHY
get structural units by id
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/structural-units
/v1/structural-units
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "merchant": {
* "active": true,
* "businessContact": "Business Contact",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "createdBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
},
* "description": "unit description",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "shortId": "1234567890",
* "technicalContact": "Technical Contact",
* "title": "Merchant title",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "updatedBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
},
* "operationAmountRoundType": "up"
},
* "projectGroups": [
* {
* "active": true,
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "createdBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "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",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "updatedBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
}
],
* "projects": [
* {
* "active": true,
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "createdBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
},
* "description": "unit description",
* "failUrl": "http(s)://google.com",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationUrl": "http(s)://google.com",
* "parentId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "scenarios": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "shortId": "1234567890",
* "successUrl": "http(s)://google.com",
* "title": "Project title",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "updatedBy": {
* "firstName": "John",
* "lastName": "Doe",
* "userId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
},
* "timezone": "Europe/Minsk",
* "config": "string"
}
],
* "unitAccessRights": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "level": "ro",
* "inherited": true
}
]
}
TEMPLATE
LIST ALL TEMPLATES
list all templates
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/templates
/v1/templates
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "templates": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
CREATE TEMPLATE
create template
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
chains
required
Array of objects (Chain)
endpoints
required
object
title
required
string [ 5 .. 100 ] characters
description
string <= 250 characters
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/templates
/v1/templates
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "title": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
}
LIST LATEST TEMPLATES
list latest templates
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/templates/latest
/v1/templates/latest
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "templates": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
GET LATEST TEMPLATE
get latest template
AUTHORIZATIONS:
BearerCookie
PATH PARAMETERS
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0
UUID
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/templates/{uuid}
/v1/templates/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
},
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
],
* "readOnly": true
}
UPDATE TEMPLATE
update template
AUTHORIZATIONS:
BearerCookie
PATH PARAMETERS
uuid
required
string <uuid> (ULID)
Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0
UUID
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
chains
required
Array of objects (Chain)
endpoints
required
object
title
required
string [ 5 .. 100 ] characters
id
required
string <uuid> (ULID)
active
boolean
description
string <= 250 characters
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/templates/{uuid}
/v1/templates/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "template": {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/templates/{uuid}/versions
/v1/templates/{uuid}/versions
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "templates": [
* {
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
],
* "terminalInfo": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "isActive": true,
* "title": "emulator",
* "integrationType": "astropay"
}
]
}
GENERATE NEW TEMPLATE
Generate new template
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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)
period
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"
range - custom from/to date range today - today, from 00:00:00 of the present
day to the current time week - this week, from 00:00:00 Monday of the current
week to the current time month - this month, from 00:00:00 of the first day of
the current month to the current time year - this year, from 00:00:00 of the
first day of the current year to the current time weekTo - week to date,
beginning the first day of the current calendar week up to the current date
00:00:00.00.000 monthTo - month to date, beginning the first day of the current
calendar month up to the current date 00:00:00.000 yearTo - year to date,
beginning the first day of the current calendar year up to the current date
00:00:00.000 15min - spanning exactly 15 minutes to the current time 30min -
spanning exactly 30 minutes to the current time 1h - spanning exactly 1 hour to
the current time 4h - spanning exactly 4 hours to the current time 12h -
spanning exactly 12 hours to the current time 24h - spanning exactly 24 hours to
the current time 7d - spanning exactly 7 days to the current time 30d - spanning
exactly 30 days to the current time 90d - spanning exactly 90 days to the
current time 1m - spanning exactly 1 month to the current time 6m - spanning
exactly 6 months to the current time 1y - spanning exactly 1 year to the current
time 2y - spanning exactly 2 years to the current time 5y - spanning exactly 5
years to the current time
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/templates/generate
/v1/templates/generate
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "projects": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "period": "range"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "active": true,
* "chains": [
* {
* "children": [
* { }
],
* "conjunction": "and",
* "endpoints": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "rules": [
* {
* "condition": "eq",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "always",
* "value": { },
* "metadata": { }
}
]
}
],
* "endpoints": {
* "property1": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
},
* "property2": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "metadata": {
* "property1": "string",
* "property2": "string"
},
* "filters": [
* {
* "type": "integration",
* "value": "string"
}
],
* "strategy": {
* "type": "first"
}
}
},
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "title": "string",
* "version": 0,
* "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"
}
TERMINAL
LIST TERMINALS
list terminals
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/terminals
/v1/terminals
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "terminals": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationType": "astropay",
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "title": "emulator",
* "config": {
* "credentials": {
* "global": {
* "baseUrl": "https://api.psp.rest/terminal-api/1",
* "terminalId": "string",
* "terminalApiKey": "string",
* "terminalSecret": "string"
}
},
* "paymentMethodsEnabled": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "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"
}
]
}
CREATE TERMINAL
create terminal
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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)
Enum: "astropay" "directa-24" "ecopayz" "emulator" "ezeewallet" "neosurf" "none"
"payzen" "skrill" "klarna" "yoomoney" "paysafecard" "card-acquirer" "tranzzo"
"sofort" "interac" "skinsback" "paycos" "eurobankpartners" "brite" "paysafe"
"yoomoney-bankcard" "emerchantpay" "paymentiq" "global-transaction-charge"
"billline" "payabl" "certus" "mpay" "dasshpe" "volt" "impaya" "inpay" "noda"
"paybrokers" "zenetpay" "gumballpay" "pay-5" "mandato" "peachpayments"
"mr-payments" "paypositive" "adamas" "canapay" "antrpay" "aps" "latpay" "isx"
"kyrenpay" "monetix" "vivawallet" "kitopay" "paycord" "bigidea" "checkout"
"crederes" "settlepay" "expefast" "payper" "epay" "ivy" "dns" "finshark"
"mifinity" "allsecure" "callpay" "kasha" "muchbetter" "ari-10" "contiant"
"utorg" "ozow" "tunzer" "rapyd" "flexify" "kaktus" "pay4fun" "sends" "flexo"
"royalpay"
title
required
string [ 1 .. 100 ] characters
labels
Array of objects (TerminalLabel)
softLimits
object (processingLimits)
currencyConversionsIds
Array of strings <uuid> (ULID)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/terminals
/v1/terminals
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "config": {
* "baseUrl": "http://example.com",
* "transactionPaymentMethods": {
* "deposit": [
* "astropay-wallet"
],
* "withdrawal": [
* "astropay-wallet"
]
}
},
* "integrationType": "astropay",
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "title": "emulator",
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationType": "astropay",
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "title": "emulator",
* "config": {
* "credentials": {
* "global": {
* "baseUrl": "https://api.psp.rest/terminal-api/1",
* "terminalId": "string",
* "terminalApiKey": "string",
* "terminalSecret": "string"
}
},
* "paymentMethodsEnabled": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "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 [ 5 .. 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
softLimits
object (processingLimits)
currencyConversionsIds
Array of strings <uuid> (ULID)
labels
Array of objects (TerminalLabel)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/terminals/{uuid}
/v1/terminals/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "config": {
* "baseUrl": "http://example.com",
* "transactionPaymentMethods": {
* "deposit": [
* "astropay-wallet"
],
* "withdrawal": [
* "astropay-wallet"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "title": "emulator"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationType": "astropay",
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "title": "emulator",
* "config": {
* "credentials": {
* "global": {
* "baseUrl": "https://api.psp.rest/terminal-api/1",
* "terminalId": "string",
* "terminalApiKey": "string",
* "terminalSecret": "string"
}
},
* "paymentMethodsEnabled": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "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"
}
ACTIVATE/DEACTIVATE TERMINAL
activate/deactivate 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 [ 5 .. 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
Activate/Deactivate Terminal
isActive
required
boolean
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/terminals/{uuid}
/v1/terminals/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "isActive": true
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationType": "astropay",
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "title": "emulator",
* "config": {
* "credentials": {
* "global": {
* "baseUrl": "https://api.psp.rest/terminal-api/1",
* "terminalId": "string",
* "terminalApiKey": "string",
* "terminalSecret": "string"
}
},
* "paymentMethodsEnabled": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/terminals/{uuid}
/v1/terminals/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationType": "astropay",
* "isActive": true,
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
],
* "currencyConversionsIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "title": "emulator",
* "config": {
* "credentials": {
* "global": {
* "baseUrl": "https://api.psp.rest/terminal-api/1",
* "terminalId": "string",
* "terminalApiKey": "string",
* "terminalSecret": "string"
}
},
* "paymentMethodsEnabled": {
* "property1": [
* "alfabank"
],
* "property2": [
* "alfabank"
]
}
},
* "softLimits": {
* "countries": [
* "AS"
],
* "currencies": [
* "EUR"
]
},
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/terminals/labels
/v1/terminals/labels
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
]
}
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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/terminals/currency-conversions/{uuid}
/v1/terminals/currency-conversions/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "terminalIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/terminals/currency-conversions/{uuid}
/v1/terminals/currency-conversions/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "terminalIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/terminals/{uuid}/currency-conversions
/v1/terminals/{uuid}/currency-conversions
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "currencyConversionIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "error": "string",
* "details": { }
}
TERMINAL LABELS
TERMINAL LABELS
list all terminal labels
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/terminals/labels
/v1/terminals/labels
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "labels": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "title": "string"
}
]
}
TRANSACTION
TRANSACTIONS
list transactions
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/transactions
/v1/transactions
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "transactions": [
* {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "operationIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "operationIntegrationIds": [
* "ea8e4bf2-87fe-446f-9881-dd8fe2f00c69"
],
* "integrations": [
* {
* "title": "string",
* "type": "astropay"
}
],
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantTransactionId": "string",
* "metadata": { },
* "operationCount": 0,
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "init",
* "type": "deposit",
* "userCountryCode": "AS",
* "paymentMethodTypes": [
* "alfabank"
]
}
]
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/transactions/{uuid}
/v1/transactions/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "operations": [
* {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "flow": "direct",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationOperationId": "string",
* "integrationStatusCode": "string",
* "integrationType": "astropay",
* "integrationTitle": "string",
* "merchantOperationId": "string",
* "credentials": { },
* "metadata": { },
* "info": { },
* "customerInfo": {
* "email": "string",
* "merchantCustomerId": "string",
* "metadata": { }
},
* "paymentInstrument": [
* "string"
],
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "cancelled",
* "terminalId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "transactionId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "charge",
* "paymentMethodType": "alfabank",
* "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",
* "finalizationDate": "2020-12-08T16:38:09.70516Z"
}
],
* "transaction": {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantTransactionId": "string",
* "metadata": { },
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "init",
* "type": "deposit",
* "userCountryCode": "AS",
* "refundableAmount": "string",
* "finalAmount": "string",
* "fullRefund": true
}
}
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 [ 5 .. 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 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"
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/transactions/{uuid}/refund
/v1/transactions/{uuid}/refund
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "amount": "string",
* "currencyCode": "EUR"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "operations": [
* {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "flow": "direct",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "integrationOperationId": "string",
* "integrationStatusCode": "string",
* "integrationType": "astropay",
* "integrationTitle": "string",
* "merchantOperationId": "string",
* "credentials": { },
* "metadata": { },
* "info": { },
* "customerInfo": {
* "email": "string",
* "merchantCustomerId": "string",
* "metadata": { }
},
* "paymentInstrument": [
* "string"
],
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "cancelled",
* "terminalId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "transactionId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "charge",
* "paymentMethodType": "alfabank",
* "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",
* "finalizationDate": "2020-12-08T16:38:09.70516Z"
}
],
* "transaction": {
* "amount": "string",
* "initialAmount": "string",
* "currencyCode": "EUR",
* "initialCurrencyCode": "EUR",
* "createdAt": "2020-12-08T16:38:09.70516Z",
* "updatedAt": "2020-12-08T16:38:09.70516Z",
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "customerId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "merchantTransactionId": "string",
* "metadata": { },
* "projectId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "status": "init",
* "type": "deposit",
* "userCountryCode": "AS",
* "refundableAmount": "string",
* "finalAmount": "string",
* "fullRefund": true
}
}
USER
USERS
list users
AUTHORIZATIONS:
BearerCookie
QUERY PARAMETERS
query
string
pgwql query
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
get/users
/v1/users
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "cursor": { },
* "fields": { },
* "users": [
* {
* "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": {
* "permissionCount": 0,
* "projectCount": 0
},
* "mfaType": "none",
* "phoneNumber": "5432394302726",
* "position": "manager",
* "username": "root@example.com"
}
]
}
CREATE USER
create user
AUTHORIZATIONS:
BearerCookie
HEADER PARAMETERS
x-merchant-id
required
string [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
408
Request timeout
500
Server error
post/users
/v1/users
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "firstName": "Ivan",
* "lastName": "Petrov",
* "phoneNumber": 12345678912345,
* "position": "manager",
* "username": "user@example.com"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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": {
* "permissionCount": 0,
* "projectCount": 0
},
* "mfaType": "none",
* "phoneNumber": "5432394302726",
* "position": "manager",
* "username": "root@example.com"
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/users/{uuid}
/v1/users/{uuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "permissions": [
* "string"
],
* "unitAccessRights": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "level": "ro",
* "inherited": true
}
],
* "user": {
* "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": {
* "permissionCount": 0,
* "projectCount": 0
},
* "mfaType": "none",
* "phoneNumber": "5432394302726",
* "position": "manager",
* "username": "root@example.com"
}
}
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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/users/{uuid}
/v1/users/{uuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "active": true,
* "firstName": "Ivan",
* "lastName": "Petrov",
* "phoneNumber": 12345678912345,
* "position": "manager"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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": {
* "permissionCount": 0,
* "projectCount": 0
},
* "mfaType": "none",
* "phoneNumber": "5432394302726",
* "position": "manager",
* "username": "root@example.com"
}
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 [ 5 .. 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
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" "read-audit-log"
"list-integrations" "manage-integrations" "update-integration-name"
"list-terminals" "create-terminal" "update-terminal" "list-templates"
"create-template" "update-template" "manage-processing-settings"
"list-transactions" "list-block-rules" "manage-block-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" "create-currency-conversion" "update-currency-conversion"
"list-currency-conversions"
revoke
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" "read-audit-log"
"list-integrations" "manage-integrations" "update-integration-name"
"list-terminals" "create-terminal" "update-terminal" "list-templates"
"create-template" "update-template" "manage-processing-settings"
"list-transactions" "list-block-rules" "manage-block-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" "create-currency-conversion" "update-currency-conversion"
"list-currency-conversions"
RESPONSES
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/users/{uuid}/permissions
/v1/users/{uuid}/permissions
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "grant": [
* "create-structural-unit"
],
* "revoke": [
* "create-structural-unit"
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
grant
required
Array of objects (UnitAccessRecordRequest)
revoke
required
Array of objects (UnitAccessRecordRequest)
RESPONSES
200
Success
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
patch/users/{uuid}/unit-access
/v1/users/{uuid}/unit-access
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "grant": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "level": "ro"
}
],
* "revoke": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "level": "ro"
}
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/dashboards/{uuid}/widgets
/v1/dashboards/{uuid}/widgets
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "widgets": [
* {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "dashboardId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "bar",
* "title": "string",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
},
* "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"
}
]
}
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 [ 5 .. 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
title
required
string [ 1 .. 200 ] characters
config
required
object (WidgetConfig)
type
required
string (WidgetType)
Enum: "bar" "stackedBar" "horizontalBar" "horizontalStackedBar" "pie" "doughnut"
"histogram" "line" "table" "measuredValue" "area"
view
required
object (WidgetView)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/{uuid}/widgets
/v1/dashboards/{uuid}/widgets
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "type": "bar",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "widget": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "dashboardId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "bar",
* "title": "string",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
},
* "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"
}
}
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 [ 5 .. 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
widgets
Array of objects (WidgetRequest)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/{uuid}/widgets/batch
/v1/dashboards/{uuid}/widgets/batch
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "widgets": [
* {
* "title": "string",
* "type": "bar",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
}
}
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
get/dashboards/{uuid}/widgets/{widgetUuid}
/v1/dashboards/{uuid}/widgets/{widgetUuid}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "widget": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "dashboardId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "bar",
* "title": "string",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
},
* "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 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 [ 5 .. 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
title
required
string [ 1 .. 200 ] characters
config
required
object (WidgetConfig)
type
required
string (WidgetType)
Enum: "bar" "stackedBar" "horizontalBar" "horizontalStackedBar" "pie" "doughnut"
"histogram" "line" "table" "measuredValue" "area"
view
required
object (WidgetView)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
put/dashboards/{uuid}/widgets/{widgetUuid}
/v1/dashboards/{uuid}/widgets/{widgetUuid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "title": "string",
* "type": "bar",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "widget": {
* "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "dashboardId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
* "type": "bar",
* "title": "string",
* "config": {
* "layout": {
* "x": "string",
* "y": "string"
},
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
},
* "view": {
* "size": {
* "columnSpan": 0,
* "rowSpan": 0
},
* "position": {
* "column": 0,
* "row": 0
},
* "showValues": "string",
* "scaleType": "string",
* "chartCount": 0
},
* "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 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 [ 5 .. 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
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
delete/dashboards/{uuid}/widgets/{widgetUuid}
/v1/dashboards/{uuid}/widgets/{widgetUuid}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "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 [ 5 .. 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)
period
object (TabularDataPeriod)
overrideQuery
object (OverrideQuery)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/{uuid}/widgets/tabular-data
/v1/dashboards/{uuid}/widgets/tabular-data
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "widgetIds": [
* "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
],
* "period": {
* "dateFrom": "2020-12-08T16:38:09.70516Z",
* "dateTo": "2020-12-08T16:38:09.70516Z",
* "timePeriod": "range",
* "timePeriodField": "createdAt",
* "timezone": "Europe/Minsk"
},
* "overrideQuery": {
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
],
* "granularity": {
* "field": "createdAt",
* "value": "1min"
}
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "tabularData": {
* "property1": "string",
* "property2": "string"
}
}
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 [ 5 .. 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
query
required
object (WidgetQuery)
RESPONSES
200
OK
400
Invalid request
401
Unauthorized
403
Forbidden
404
Not found
408
Request timeout
500
Server error
post/dashboards/widgets/tabular-data
/v1/dashboards/widgets/tabular-data
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "query": {
* "table": "operation_event",
* "granularity": {
* "field": "createdAt",
* "value": "1min"
},
* "group": [
* "integrationType"
],
* "order": [
* {
* "alias": "string",
* "asc": true
}
],
* "select": [
* {
* "field": "id",
* "metric": "average",
* "alias": "string",
* "parameters": [
* 0
]
}
],
* "where": [
* {
* "field": "id",
* "condition": "in",
* "value": 0
}
]
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 408
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "tabularData": [
* "string"
]
}