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": {"property1": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"friendlyName": "string",
"logo": "string"
},
"property2": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"friendlyName": "string",
"logo": "string"
}
},
"paymentMethods": {"property1": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"integrations": [{"integrationName": "string",
"kinds": ["deposit"
]
}
],
"friendlyName": "string",
"logo": "string"
},
"property2": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"integrations": [{"integrationName": "string",
"kinds": ["deposit"
]
}
],
"friendlyName": "string",
"logo": "string"
}
}
}

ExchangeRates

Get exchange rates

get current exchange rates

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

{"rates": [{"from": "EUR",
"timestamp": "2020-12-08T16:38:09.70516Z",
"provider": "string",
"to": [{"currency": "EUR",
"rate": "string"
}
]
}
]
}

Get exchange rates currencies

get exchange rates currencies

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

{"currencies": [{"currency": "string",
"createdAt": "2020-12-08T16:38:09.70516+03:00",
"createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
]
}

Add new exchange rates currency

add new exchange rates currency

Authorizations:

BearerCookie

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

KYC rule data to create

currencies

required

Array of strings <iso4217-currency-code> (currencyCode) [ items <iso4217-currency-code > [ 3 .. 7 ] characters ]

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

Responses

Request samples

Payload

Content type

application/json

{"currencies": ["EUR"
]
}

Response samples

400
401
403
408
500

Content type

application/json

{"error": "string",
"details": { }
}

KYC Rules

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

Payload

Content type

application/json

{"title": "string",
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"description": "string",
"reason": "string"
}

Response samples

Content type

application/json

{"kycRule": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
}
}

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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
}
]
}

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

query Parameters

lockId	string <uuid> (ULID) Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0 lock ID
releaseLock	string (Boolean) lock management boolean variable

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

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

Payload

Content type

application/json

{"title": "string",
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"description": "string",
"reason": "string"
}

Response samples

Content type

application/json

{"kycRule": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
},
"lock": {"lockId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockEntityId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
}

Get latest KYC Rule

get latest 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

query Parameters

withLock

string (Boolean)

lock management boolean variable

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type

application/json

{"kycRule": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
},
"lock": {"lockId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockEntityId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
}

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

query Parameters

lockId	string <uuid> (ULID) Example: lockId=c41fed51-7b1d-4b8c-89f3-101e26e825f0 lock ID
releaseLock	string (Boolean) lock management boolean variable

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Request Body schema: application/json

KYC rule data to partially update

active

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"active": true
}

Response samples

Content type

application/json

{"kycRule": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
},
"lock": {"lockId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockEntityId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"lockedBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
}

Delete KYC Rule

delete 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

query Parameters

withLock

string (Boolean)

lock management boolean variable

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type

application/json

{"error": "string",
"details": { }
}

List all versions for KYC Rule

list all versions for 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)

Responses

Response samples

Content type

application/json

{"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"versions": [{"version": 0,
"reason": "string",
"createdAt": "2020-12-08T16:38:09.70516+03:00",
"createdBy": "c41fed51-7b1d-4b8c-89f3-101e26e825f0"
}
]
}

Get version for KYC Rule

get version for 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
version required	integer entity version

header Parameters

x-merchant-id required	string [ 1 .. 100 ] characters Merchant short ID, provided to you by the FinteqHub team.
x-fingerprint required	string = 32 characters Fingerprint
x-request-id	string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 Request ID (if the empty header is generated new random UUID automatically)

Responses

Response samples

Content type

application/json

{"kycRule": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"version": 0,
"active": true,
"chains": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rules": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
],
"actions": [{"type": "paymentMethod",
"condition": "eq",
"value": null,
"metadata": null
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"versionCreatedAt": "2019-08-24T14:15:22Z",
"versionCreatedBy": "e82cb58c-5935-49b5-81f6-b279aaadc997",
"description": "string",
"reason": "string"
}
}

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
formRedirectUrlEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"title": "Merchant Title",
"active": true,
"contacts": ["[email protected]",
"[email protected]"
],
"registrationCountry": "AS",
"licenses": "License information",
"kycEnabled": true,
"pciDssCompliant": true,
"formRedirectUrlEnabled": true
}

Response samples

Content type

application/json

{"merchant": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true,
"shortId": "1234567890",
"title": "Merchant Title",
"contacts": ["[email protected]",
"[email protected]"
],
"registrationCountry": "AS",
"licenses": "License information",
"kycEnabled": false,
"pciDssCompliant": false,
"formRedirectUrlEnabled": false,
"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 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
formRedirectUrlEnabled	boolean
kycEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"pciDssCompliant": true,
"formRedirectUrlEnabled": true,
"kycEnabled": true
}

Response samples

Content type

application/json

{"merchant": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true,
"shortId": "1234567890",
"title": "Merchant Title",
"contacts": ["[email protected]",
"[email protected]"
],
"registrationCountry": "AS",
"licenses": "License information",
"kycEnabled": false,
"pciDssCompliant": false,
"formRedirectUrlEnabled": false,
"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"
}
}

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
formRedirectUrlEnabled	boolean
integrations	Array of strings (integrationType) List of integration types to enable for the merchant

Responses

Request samples

Payload

Content type

application/json

{"shortId": "merchant1",
"title": "Merchant Title",
"contacts": ["[email protected]",
"[email protected]"
],
"registrationCountry": "AS",
"licenses": "License information",
"kycEnabled": false,
"pciDssCompliant": false,
"formRedirectUrlEnabled": false,
"integrations": ["emerchantpay",
"nuvei"
]
}

Response samples

Content type

application/json

{"merchant": {"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true,
"shortId": "1234567890",
"title": "Merchant Title",
"contacts": ["[email protected]",
"[email protected]"
],
"registrationCountry": "AS",
"licenses": "License information",
"kycEnabled": false,
"pciDssCompliant": false,
"formRedirectUrlEnabled": false,
"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"
}
}

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": [{"id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"merchantShortId": "string",
"name": "string",
"address": "string",
"createdAt": "2020-12-08T16:38:09.70516+03:00",
"updatedAt": "2020-12-08T16:38:09.70516+03:00"
}
]
}

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

Payload

Content type

application/json

{"merchantIntegrations": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true
}
],
"merchantPaymentMethods": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodKind": "deposit",
"active": true
}
]
}

Response samples

Content type

application/json

{"merchantIntegrations": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true
}
],
"merchantPaymentMethods": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodKind": "deposit",
"active": true
}
]
}

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

Payload

Content type

application/json

{"merchantIntegrations": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true
}
],
"merchantPaymentMethods": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodKind": "deposit",
"active": true
}
]
}

Response samples

Content type

application/json

{"merchantIntegrations": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true
}
],
"merchantPaymentMethods": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodKind": "deposit",
"active": true
}
]
}

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": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"active": true
}
],
"merchantPaymentMethods": [{"integrationId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodId": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
"paymentMethodKind": "deposit",
"active": true
}
]
}