FinteqHub WLA API Reference

Download OpenAPI specification:Download

Dictionaries

Get integrations dictionary

get integrations dictionary

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Responses

Response samples

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

KYC Rules

List KYC Rules

list all latest KYC rules

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Responses

Response samples

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

Create KYC Rule

create KYC rule

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

KYC rule data to create

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

Responses

Request samples

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

Response samples

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

Update KYC Rule

update KYC rule

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

KYC rule data to update

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

Responses

Request samples

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

Response samples

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

Partial Update KYC Rule

partially update KYC rule

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

KYC rule data to partially update

active
required
boolean

Responses

Request samples

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

Response samples

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

Merchant

Update Merchant

update merchant

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

merchant data to update

title
required
string [ 1 .. 30 ] characters
active
required
boolean
registrationCountry
required
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"
contacts
Array of strings
licenses
string
kycEnabled
boolean
pciDssCompliant
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Merchant Title",
  • "active": true,
  • "registrationCountry": "AS",
  • "licenses": "License information",
  • "kycEnabled": true,
  • "pciDssCompliant": true
}

Response samples

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

Update Merchant partially

update merchant partially

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

merchant data to update

active
required
boolean
pciDssCompliant
boolean

Responses

Request samples

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

Response samples

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

Login to Merchant

login to merchant

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

UUID

query Parameters
merchantId
required
string

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

fingerprint
required
string = 32 characters

Fingerprint

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

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

Responses

Response samples

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

Create Merchant

create merchant

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

merchant data to create

shortId
required
string [ 1 .. 50 ] characters

Only lowercase letters and digits allowed (merchant/examplemerchant/merchant1/testmerchant)

title
required
string [ 1 .. 100 ] characters
registrationCountry
required
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"
contacts
Array of strings
licenses
string
kycEnabled
boolean
pciDssCompliant
boolean
integrations
Array of strings (integrationType)

List of integration types to enable for the merchant

Responses

Request samples

Content type
application/json
{
  • "shortId": "merchant1",
  • "title": "Merchant Title",
  • "registrationCountry": "AS",
  • "licenses": "License information",
  • "kycEnabled": false,
  • "pciDssCompliant": false,
  • "integrations": [
    ]
}

Response samples

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

Merchant Services

list merchant services

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Responses

Response samples

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

Create Merchant Integrations

create merchant integrations

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

merchant integrations data to create

Array of objects (MerchantIntegration)
Array of objects (MerchantPaymentMethod)

Responses

Request samples

Content type
application/json
{
  • "merchantIntegrations": [
    ],
  • "merchantPaymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "merchantIntegrations": [
    ],
  • "merchantPaymentMethods": [
    ]
}

Update Merchant Integrations

update merchant integrations

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Request Body schema: application/json

merchant integrations data to update

Array of objects (MerchantIntegration)
Array of objects (MerchantPaymentMethod)

Responses

Request samples

Content type
application/json
{
  • "merchantIntegrations": [
    ],
  • "merchantPaymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "merchantIntegrations": [
    ],
  • "merchantPaymentMethods": [
    ]
}

List Merchant Integrations

list merchant integrations

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

UUID

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

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

x-fingerprint
required
string = 32 characters

Fingerprint

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

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

Responses

Response samples

Content type
application/json
{
  • "merchantIntegrations": [
    ],
  • "merchantPaymentMethods": [
    ]
}