get integrations dictionary
| 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) |
{- "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"
}
}
}list all latest KYC rules
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
{- "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"
}
]
}create KYC rule
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
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 |
{- "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"
}{- "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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| ruleId required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 |
| 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) |
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 |
{- "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"
}{- "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"
}
]
}partially update KYC rule
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| ruleId required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 |
| 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) |
KYC rule data to partially update
| active required | boolean |
{- "active": true
}{- "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 merchant
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
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 |
{- "title": "Merchant Title",
- "active": true,
- "registrationCountry": "AS",
- "licenses": "License information",
- "kycEnabled": true,
- "pciDssCompliant": true
}{- "merchant": {
- "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
- "active": true,
- "shortId": "1234567890",
- "title": "Merchant Title",
- "registrationCountry": "AS",
- "licenses": "License information",
- "kycEnabled": false,
- "pciDssCompliant": 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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
merchant data to update
| active required | boolean |
| pciDssCompliant | boolean |
{- "active": true,
- "pciDssCompliant": true
}{- "merchant": {
- "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
- "active": true,
- "shortId": "1234567890",
- "title": "Merchant Title",
- "registrationCountry": "AS",
- "licenses": "License information",
- "kycEnabled": false,
- "pciDssCompliant": 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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
{- "error": "string",
- "details": { }
}create merchant
| 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) |
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 |
{- "shortId": "merchant1",
- "title": "Merchant Title",
- "registrationCountry": "AS",
- "licenses": "License information",
- "kycEnabled": false,
- "pciDssCompliant": false,
- "integrations": [
- "emerchantpay",
- "nuvei"
]
}{- "merchant": {
- "id": "c41fed51-7b1d-4b8c-89f3-101e26e825f0",
- "active": true,
- "shortId": "1234567890",
- "title": "Merchant Title",
- "registrationCountry": "AS",
- "licenses": "License information",
- "kycEnabled": false,
- "pciDssCompliant": 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"
}
}list merchant services
| 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) |
{- "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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
merchant integrations data to create
Array of objects (MerchantIntegration) | |
Array of objects (MerchantPaymentMethod) |
{- "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
}
]
}{- "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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
merchant integrations data to update
Array of objects (MerchantIntegration) | |
Array of objects (MerchantPaymentMethod) |
{- "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
}
]
}{- "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
| uuid required | string <uuid> (ULID) Example: c41fed51-7b1d-4b8c-89f3-101e26e825f0 UUID |
| 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) |
{- "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
}
]
}