diff --git a/src/assets/apis/three-d-s-server/en.yaml b/src/assets/apis/three-d-s-server/en.yaml index efec45f6..aeebed4b 100644 --- a/src/assets/apis/three-d-s-server/en.yaml +++ b/src/assets/apis/three-d-s-server/en.yaml @@ -600,7 +600,6 @@ paths: - name - token - expires_at - - enrollment properties: id: type: integer @@ -612,43 +611,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer branches: type: array items: @@ -669,43 +631,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer required: - status - data @@ -854,9 +779,6 @@ paths: mcc: type: number description: 'Merchant category code' - enrollment: - type: boolean - description: 'Indicator that specifies whether to enroll the merchant in the brand' isicClass: type: number description: ISIC class code @@ -1046,9 +968,6 @@ paths: * The URL must not include fragments. (hash or anchors, https://example.com`#section`). * The URL must have a defined host. (https://`path`) * The host cannot be an IP address. (https://`192.168.1.1`) - enrollment: - type: boolean - description: 'Indicator that specifies whether to enroll the branch in the brand @deprecated' subscriptions: type: array uniqueItems: true @@ -1140,43 +1059,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer required: - status - data diff --git a/src/assets/apis/three-d-s-server/es.yaml b/src/assets/apis/three-d-s-server/es.yaml index d52e1606..79af7bc9 100644 --- a/src/assets/apis/three-d-s-server/es.yaml +++ b/src/assets/apis/three-d-s-server/es.yaml @@ -600,7 +600,6 @@ paths: - name - token - expires_at - - enrollment properties: id: type: integer @@ -612,43 +611,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer branches: type: array items: @@ -669,43 +631,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer required: - status - data @@ -854,9 +779,6 @@ paths: mcc: type: number description: 'código de categoría de comercial ' - enrollment: - type: boolean - description: 'Indicador que indica si desea enrolar el comercio en la marca' isicClass: type: number description: Código clase CIIU @@ -1046,9 +968,6 @@ paths: * La URL no debe incluir fragmentos (hash o anclas, https://example.com`#section`). * La URL debe tener un host definido. (https://`path`) * El host no puede ser una dirección IP. (https://`192.168.1.1`) - enrollment: - type: boolean - description: 'Indicador que indica si desea enrolar el comercio en la marca @deprecated' subscriptions: type: array uniqueItems: true @@ -1140,43 +1059,6 @@ paths: expires_at: type: string format: date-time - enrollment: - type: object - properties: - mastercard: - type: object - required: - - uuid - - messageType - - data - - subscriptionId - properties: - uuid: - type: string - format: uuid - messageType: - type: string - data: - type: object - properties: - acquirerBIN: - type: string - acquirerICA: - type: string - acquirerName: - type: string - acquirerCID: - type: string - status: - type: string - reason: - type: string - modelId: - type: string - modelName: - type: string - subscriptionId: - type: integer required: - status - data diff --git a/src/constants/navigations.js b/src/constants/navigations.js index 1c980218..33da4a1a 100644 --- a/src/constants/navigations.js +++ b/src/constants/navigations.js @@ -1136,10 +1136,6 @@ export const TAB_NAVIGATION = { title: 'API Sucursales', href: '/three-d-s-server/api/merchants/branch', }, - { - title: 'API Suscribir Modelos (obsoleta)', - href: '/three-d-s-server/api/merchants/enrolment', - }, { title: 'API Suscripciones', href: '/three-d-s-server/api/subscriptions/show', @@ -1311,10 +1307,6 @@ export const TAB_NAVIGATION = { title: 'Branches API', href: '/three-d-s-server/api/merchants/branch', }, - { - title: 'Enrolment model API (deprecated)', - href: '/three-d-s-server/api/merchants/enrolment', - }, { title: 'Subscriptions API', href: '/three-d-s-server/api/subscriptions/show', diff --git a/src/pages/en/three-d-s-server/api/merchants/branch.mdx b/src/pages/en/three-d-s-server/api/merchants/branch.mdx index d5f6ec46..d84dc9de 100644 --- a/src/pages/en/three-d-s-server/api/merchants/branch.mdx +++ b/src/pages/en/three-d-s-server/api/merchants/branch.mdx @@ -42,7 +42,6 @@ export const apiRefs = ['/api/v1/merchants/{merchantID}/branches']; "currency": "COP", "url": "https://example-dos.com" "enabled": true, - "enrollment": true, "subscriptions": [ { "franchise": "visa", @@ -96,24 +95,7 @@ export const apiRefs = ['/api/v1/merchants/{merchantID}/branches']; "brand": "Company City B", "url": "https://company-b.com" "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2026-04-28 14:12:46", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 352 - } - } + "expires_at": "2026-04-28 14:12:46" } ] } diff --git a/src/pages/en/three-d-s-server/api/merchants/create.mdx b/src/pages/en/three-d-s-server/api/merchants/create.mdx index 17866da5..989281ea 100644 --- a/src/pages/en/three-d-s-server/api/merchants/create.mdx +++ b/src/pages/en/three-d-s-server/api/merchants/create.mdx @@ -34,7 +34,6 @@ export const apiRefs = ['/api/v1/merchants']; "url": "https://www.merchant.com", "mcc": 742, "isicClass": 111, - "enrollment": true, "document": { "type": "NIT", "number": "1234567895" @@ -61,7 +60,6 @@ export const apiRefs = ['/api/v1/merchants']; "currency": "COP", "url": "https://www.branch1.merchant.com", "enabled": true, - "enrollment": true, "subscriptions": [ { "franchise": "visa", @@ -124,48 +122,14 @@ export const apiRefs = ['/api/v1/merchants']; "id":1, "name":"Merchant one", "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2024-09-16 15:30:45", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 352 - } - }, + "expires_at": "2024-09-16 15:30:45" }, "branches":[ { "id":1, "name":"Branch one", "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2024-09-16 15:30:45", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 351 - } - } + "expires_at": "2024-09-16 15:30:45" }, { "id":2, @@ -206,8 +170,7 @@ export const apiRefs = ['/api/v1/merchants']; | **url** | Yes | String | Max. 90 characters | Valid URL (ValidUrlRule) | | Valid URL | | **mcc** | Yes | Numeric | | Merchant_category_codes table, code column | merchant_category_codes table, code column | | | **isicClass** | No | Numeric | | Isic_classes table, code document | isic_classes table, code document | | -| **type** | No | String | | Document_types table, name column | document_types table, name column | | -| **enrollment** | No | Boolean | | | | | +| **type** | No | String | | Document_types table, name column | document_types table, name column | | | | | | **number** | No | String | | Dependent on document type | | Regex pattern dependent on document type | | **subscriptions[n].
franchise** | Yes | String | | Franchises table, brand(name) column, Custom validations (FranchiseEnabled, DirectoryServerExists, DirectoryServerEnabled) | franchises table, brand(name) column | | | **subscriptions[n].
acquirerBIN** | Yes | Numeric | | Custom validations (AcquirerBinExists, AcquirerEnabled) | | | @@ -217,8 +180,7 @@ export const apiRefs = ['/api/v1/merchants']; | **branches[n].
brand** | Yes | String | Max. 25 characters | | | | | **branches[n].
country** | Yes | String | Exactly 3 characters | Countries table, alpha_3_code column | countries table, alpha_3_code column | | | **branches[n].
currency** | Yes | String | | Currencies table, alphabetic_code column | currencies table, alphabetic_code column | | -| **branches[n].
enabled** | No | Boolean | | | | | -| **branches[n].
enrollment** | No | Boolean | | | | | +| **branches[n].
enabled** | No | Boolean | | | | | | | | | **branches[n].
subscriptions[n].
franchise** | Yes | String | | Franchises table, brand(name) column, Custom validations (FranchiseEnabled, DirectoryServerExists, DirectoryServerEnabled) | franchises table, brand(name) column | | | **branches[n].
subscriptions[n].
acquirerBIN** | Yes | Numeric | | Custom validations (AcquirerBinExists, AcquirerEnabled) | | | | **branches[n].
subscriptions[n].
merchantCode** | Yes | String | | | | | @@ -237,6 +199,5 @@ export const apiRefs = ['/api/v1/merchants']; - **Protocol:** Defines the allowed values for the `version` field. - **BranchUnique:** The value in the `branches[n].name` field must be unique for each branch. - **Valid email:** The `invitations[n]` field must be a valid email address. -- **Enrollment:** This value should be sent when requesting enrollment of the tokenizable `merchant` or `branch` model with the brand. Currently, this service is only available for Mastercard. This table covers all fields and their respective rules for each section mentioned. You can adjust it according to your system specifications. diff --git a/src/pages/en/three-d-s-server/api/merchants/enrolment.mdx b/src/pages/en/three-d-s-server/api/merchants/enrolment.mdx deleted file mode 100644 index 03c75dfa..00000000 --- a/src/pages/en/three-d-s-server/api/merchants/enrolment.mdx +++ /dev/null @@ -1,192 +0,0 @@ -# Model Enrollment - -Deprecated since September 29th at Mastercard's request in bulletin: AN11171 - -The **Model Enrollment** APIs are designed to manage model enrollment across supported brands, -facilitating operations such as creating, updating, and deleting related records. - -Currently, these APIs are exclusively enabled for **Mastercard**, -allowing efficient integration and management of models within their ecosystem. - -These APIs provide a clear and structured interface for interacting with enrollment data, -ensuring that processes are secure and aligned with company standards. - ---- - -#### **Key Features:** -1. **Model Creation**: Register a new model in the system using the `POST /api/model-enrollment` endpoint. -2. **Model Updates**: Modify details of an existing model through the `PATCH /api/model-enrollment` endpoint. -3. **Model Deletion**: Remove obsolete model records using the `DELETE /api/model-enrollment` endpoint. - ---- - - -### POST `/api/model-enrollment` - -This endpoint allows you to enroll a new model in a brand. Currently, the service is exclusively available for **Mastercard**. - ---- - -#### **Request** - -```json -{ - "subscription_id": "349" -} - -``` - -| Field | Type | Description | -|----------------------|----------|------------------------------------------------| -| **subscription_id** | `string` | ID of the subscription associated with the new model. | - ---- - -#### **Response** - -```json - -{ - "message": "Model enrollment", - "data": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - } - } - } -} - -``` - - -| Field | Type | Description | -|---------------------------------------|----------|---------------------------------------------------------------------| -| **message** | `string` | Message confirming the model enrollment. | -| **data** | `object` | Data related to the enrolled model. | -| **mastercard** | `object` | Brand-related data. | -| **data.mastercard.uuid** | `string` | Unique identifier of the enrolled model. | -| **data.mastercard.messageType** | `string` | Message type related to the model status. | -| **data.mastercard.data** | `object` | Additional details related to the model. | -| **data.mastercard.data.acquirerBIN** | `string` | Acquirer identification number. | -| **data.mastercard.data.acquirerICA** | `string` | Acquirer institution code. | -| **data.mastercard.data.acquirerName** | `string` | Acquirer name. | -| **data.mastercard.data.acquirerCID** | `string` | Acquirer client identifier. | -| **data.mastercard.data.status** | `string` | Detailed operation status (`SUCCESS`, `REJECTED`, `FAILED`). | -| **data.mastercard.data.reason** | `string` | Reason related to the performed operation. | -| **data.mastercard.data.modelId** | `string` | Identifier of the enrolled model. | -| **data.mastercard.data.modelName** | `string` | Name of the enrolled model. | - - -### PATCH `/api/model-enrollment` - -This endpoint allows you to retrieve data from the associated brand and update the enrolled model. Currently, the service is exclusively available for **Mastercard**. - ---- - -#### **Request** - -```json -{ - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "subscription_id": "349" -} - -``` - -Request fields: - -| Field | Type | Description | -|----------------------|----------|-----------------------------------------------------------| -| **uuid** | `string` | Unique identifier of the record to be updated. | -| **subscription_id** | `string` | ID of the subscription associated with the record. | - - -#### **Response** - -```json -{ - "message": "Model updated", - "data": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - } - } - } -} - -``` - -| Field | Type | Description | -|---------------------------------------|----------|---------------------------------------------------------------------| -| **message** | `string` | Message confirming the model update. | -| **data** | `object` | Updated data related to the model. | -| **mastercard** | `object` | Brand-related data. | -| **data.mastercard.uuid** | `string` | Unique identifier of the updated record. | -| **data.mastercard.messageType** | `string` | Message type related to the model status. | -| **data.mastercard.data** | `object` | Additional details related to the model. | -| **data.mastercard.data.acquirerBIN** | `string` | Acquirer identification number. | -| **data.mastercard.data.acquirerICA** | `string` | Acquirer institution code. | -| **data.mastercard.data.acquirerName** | `string` | Acquirer name. | -| **data.mastercard.data.acquirerCID** | `string` | Acquirer client identifier. | -| **data.mastercard.data.status** | `string` | Detailed operation status (`SUCCESS`, `REJECTED`, `FAILED`). | -| **data.mastercard.data.reason** | `string` | Reason related to the performed operation. | -| **data.mastercard.data.modelId** | `string` | Identifier of the updated model. | -| **data.mastercard.data.modelName** | `string` | Name of the updated model. | - - ---- - -### DELETE `/api/model-enrollment` - -This endpoint allows you to manage model enrollment in a brand. Currently, the service is exclusively available for **Mastercard**. - ---- - -#### **Request** - -```json - -{ - "reason": "DATA_ENTRY_ERROR", - "subscription_id": "349", - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b" -} - -``` - -| Field | Type | Description | -|----------------------|----------|---------------------------------------------------------------| -| **reason** | `string` | Reason for deleting the record. Example: `DATA_ENTRY_ERROR`. | -| **subscription_id** | `string` | ID of the subscription associated with the record. | -| **uuid** | `string` | Unique identifier of the record to be deleted. | - - -#### **Response** - -```json - -{ - "message": "The record was successfully deleted" -} - -``` diff --git a/src/pages/three-d-s-server/api/merchants/branch.mdx b/src/pages/three-d-s-server/api/merchants/branch.mdx index b324b816..97fd691d 100644 --- a/src/pages/three-d-s-server/api/merchants/branch.mdx +++ b/src/pages/three-d-s-server/api/merchants/branch.mdx @@ -42,7 +42,6 @@ export const apiRefs = ['/api/v1/merchants/{merchantID}/branches']; "currency": "COP", "url": "https://example-dos.com" "enabled": true, - "enrollment": true, "subscriptions": [ { "franchise": "visa", @@ -96,24 +95,7 @@ export const apiRefs = ['/api/v1/merchants/{merchantID}/branches']; "brand": "Compañía Ciudad B", "url": "https://company-b.com", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2026-04-28 14:12:46", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 352 - } - } + "expires_at": "2026-04-28 14:12:46" } ] } diff --git a/src/pages/three-d-s-server/api/merchants/create.mdx b/src/pages/three-d-s-server/api/merchants/create.mdx index 7355d491..d948aeff 100644 --- a/src/pages/three-d-s-server/api/merchants/create.mdx +++ b/src/pages/three-d-s-server/api/merchants/create.mdx @@ -34,7 +34,6 @@ export const apiRefs = ['/api/v1/merchants']; "url": "https://www.comercio.com", "mcc": 742, "isicClass": 111, - "enrollment": true, "document": { "type": "NIT", "number": "1234567895" @@ -61,7 +60,6 @@ export const apiRefs = ['/api/v1/merchants']; "currency": "COP", "url": "https://www.sucursal1.comercio.com", "enabled": true, - "enrollment": true, "subscriptions": [ { "franchise": "visa", @@ -124,48 +122,14 @@ export const apiRefs = ['/api/v1/merchants']; "id":1, "name":"Comercio uno", "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2024-09-16 15:30:45", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 352 - } - }, + "expires_at": "2024-09-16 15:30:45" }, "branches":[ { "id":1, "name":"Sucursal uno", "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", - "expires_at": "2024-09-16 15:30:45", - "enrollment": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - }, - "subscriptionId": 351 - } - } + "expires_at": "2024-09-16 15:30:45" }, { "id":2, @@ -206,8 +170,7 @@ export const apiRefs = ['/api/v1/merchants']; | **url** | Sí | String | Máx. 90 caracteres | URL válida (ValidUrlRule) | | URL válida | | **mcc** | Sí | Numérico | | Tabla merchant_category_codes, columna code | Tabla merchant_category_codes, columna code | | | **isicClass** | No | Numérico | | Tabla isic_classes, columna code document | Tabla isic_classes, columna code document | | -| **type** | No | String | | Tabla document_types, columna name | Tabla document_types, columna name | | -| **enrollment** | No | Booleano | | | | | +| **type** | No | String | | Tabla document_types, columna name | Tabla document_types, columna name | | | | | | **number** | No | String | | Dependiente del tipo de documento | | Patrón regex dependiente del tipo de documento | | **subscriptions[n].
franchise** | Sí | String | | Tabla franchises, columna brand(name), Validaciones personalizadas (FranchiseEnabled, DirectoryServerExists, DirectoryServerEnabled) | Tabla franchises, columna brand(name) | | | **subscriptions[n].
acquirerBIN** | Sí | Numérico | | Validaciones personalizadas (AcquirerBinExists, AcquirerEnabled) | | | @@ -217,8 +180,7 @@ export const apiRefs = ['/api/v1/merchants']; | **branches[n].
brand** | Sí | String | Máx. 25 caracteres | | | | | **branches[n].
country** | Sí | String | Exactamente 3 caracteres | Tabla countries, columna alpha_3_code | Tabla countries, columna alpha_3_code | | | **branches[n].
currency** | Sí | String | | Tabla currencies, columna alphabetic_code | Tabla currencies, columna alphabetic_code | | -| **branches[n].
enabled** | No | Booleano | | | | | -| **branches[n].
enrollment** | No | Booleano | | | | | +| **branches[n].
enabled** | No | Booleano | | | | | | | | | **branches[n].
subscriptions[n].
franchise** | Sí | String | | Tabla franchises, columna brand(name), Validaciones personalizadas (FranchiseEnabled, DirectoryServerExists, DirectoryServerEnabled) | Tabla franchises, columna brand(name) | | | **branches[n].
subscriptions[n].
acquirerBIN** | Sí | Numérico | | Validaciones personalizadas (AcquirerBinExists, AcquirerEnabled) | | | | **branches[n].
subscriptions[n].
merchantCode** | Sí | String | | | | | @@ -237,6 +199,5 @@ export const apiRefs = ['/api/v1/merchants']; - **Protocol:** Define los valores permitidos para el campo `version`. - **BranchUnique:** El valor en el campo `branches[n].name` debe ser único para cada sucursal. - **Email válido:** El campo `invitations[n]` debe ser una dirección de correo electrónico válida. -- **Enrollment:** Este valor se debe enviar en caso de requerir solicitud de enrolamiento del modelo tokenizable `merchant` o `branch` ante la marca, actualmente este servicio esta disponible solo para mastercard Esta tabla cubre todos los campos y sus respectivas reglas para cada sección que has mencionado. Puedes ajustarla según las especificaciones de tu sistema. diff --git a/src/pages/three-d-s-server/api/merchants/enrolment.mdx b/src/pages/three-d-s-server/api/merchants/enrolment.mdx deleted file mode 100644 index 9e162437..00000000 --- a/src/pages/three-d-s-server/api/merchants/enrolment.mdx +++ /dev/null @@ -1,190 +0,0 @@ -# Model Enrollment - -En desuso desde el 29 de Septiembre por solicitud de Mastercard en boletín: AN11171 - -Las APIs de **Model Enrollment** están diseñadas para gestionar el enrolamiento de modelos en las marcas soportadas, -facilitando operaciones como la creación, actualización y eliminación de registros relacionados. - -Actualmente, estas APIs están habilitadas exclusivamente para **Mastercard**, -permitiendo integrar y gestionar modelos de manera eficiente dentro de su ecosistema. - -Estas APIs proporcionan una interfaz clara y estructurada para interactuar con los datos de enrolamiento, -asegurando que los procesos sean seguros y estén alineados con los estándares de la compañia. - ---- - -#### **Funciones principales:** -1. **Creación de modelos**: Registrar un nuevo modelo en el sistema utilizando el endpoint `POST /api/model-enrollment`. -2. **Actualización de modelos**: Modificar los detalles de un modelo existente mediante el endpoint `PATCH /api/model-enrollment`. -3. **Eliminación de modelos**: Eliminar registros de modelos obsoletos utilizando el endpoint `DELETE /api/model-enrollment`. - ---- - - -### POST `/api/model-enrollment` - -Este endpoint permite enrolar un nuevo modelo en una marca. Actualmente, el servicio está disponible exclusivamente para **Mastercard**. - ---- - -#### **Request** - -```json -{ - "subscription_id": "349" -} - -``` - -| Campo | Tipo | Descripción | -|---------------------|----------|------------------------------------------------| -| **subscription_id** | `string` | ID de la suscripción asociada al nuevo modelo. | - ---- - -```json - -{ - "message": "Model enrollment", - "data": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - } - } - } -} - -``` - - -| Campo | Tipo | Descripción | -|---------------------------------------|----------|---------------------------------------------------------------------| -| **message** | `string` | Mensaje que confirma el enrolamiento del modelo. | -| **data** | `object` | Datos relacionados con el modelo enrolado. | -| **mastercard** | `object` | Datos relacionados con la marca. | -| **data.mastercard.uuid** | `string` | Identificador único del modelo enrolado. | -| **data.mastercard.messageType** | `string` | Tipo de mensaje relacionado con el estado del modelo. | -| **data.mastercard.data** | `object` | Detalles adicionales relacionados con el modelo. | -| **data.mastercard.data.acquirerBIN** | `string` | Número de identificación del adquirente. | -| **data.mastercard.data.acquirerICA** | `string` | Código de institución del adquirente. | -| **data.mastercard.data.acquirerName** | `string` | Nombre del adquirente. | -| **data.mastercard.data.acquirerCID** | `string` | Identificador del cliente del adquirente. | -| **data.mastercard.data.status** | `string` | Estado detallado de la operación (`SUCCESS`, `REJECTED`, `FAILED`). | -| **data.mastercard.data.reason** | `string` | Razón relacionada con la operación realizada. | -| **data.mastercard.data.modelId** | `string` | Identificador del modelo enrolado. | -| **data.mastercard.data.modelName** | `string` | Nombre del modelo enrolado. | - - -### PATCH `/api/model-enrollment` - -Este endpoint permite recuperar los datos en la marca asociada y actualizar el modelo enrolado. Actualmente, el servicio está disponible exclusivamente para **Mastercard**. - ---- - -#### **Request** - -```json -{ - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "subscription_id": "349" -} - -``` - -Campos de la solicitud: - -| Campo | Tipo | Descripción | -|---------------------|----------|-----------------------------------------------------------| -| **uuid** | `string` | Identificador único del registro que se desea actualizar. | -| **subscription_id** | `string` | ID de la suscripción asociada al registro. | - - -#### **Response** - -```json -{ - "message": "Model updated", - "data": { - "mastercard": { - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b", - "messageType": "MerchantStatusResponse", - "data": { - "acquirerBIN": "510510", - "acquirerICA": "16233", - "acquirerName": "First Technology Federal Credit Union", - "acquirerCID": "139423", - "status": "SUCCESS", - "reason": "New Record Data", - "modelId": "123", - "modelName": "Test Merchant" - } - } - } -} - -``` - -| Campo | Tipo | Descripción | -|---------------------------------------|----------|---------------------------------------------------------------------| -| **message** | `string` | Mensaje que confirma la actualización del modelo. | -| **data** | `object` | Datos actualizados relacionados con el modelo. | -| **mastercard** | `object` | Datos relacionados con la marca. | -| **data.mastercard.uuid** | `string` | Identificador único del registro actualizado. | -| **data.mastercard.messageType** | `string` | Tipo de mensaje relacionado con el estado del modelo. | -| **data.mastercard.data** | `object` | Detalles adicionales relacionados con el modelo. | -| **data.mastercard.data.acquirerBIN** | `string` | Número de identificación del adquirente. | -| **data.mastercard.data.acquirerICA** | `string` | Código de institución del adquirente. | -| **data.mastercard.data.acquirerName** | `string` | Nombre del adquirente. | -| **data.mastercard.data.acquirerCID** | `string` | Identificador del cliente del adquirente. | -| **data.mastercard.data.status** | `string` | Estado detallado de la operación (`SUCCESS`, `REJECTED`, `FAILED`). | -| **data.mastercard.data.reason** | `string` | Razón relacionada con la operación realizada. | -| **data.mastercard.data.modelId** | `string` | Identificador del modelo actualizado. | -| **data.mastercard.data.modelName** | `string` | Nombre del modelo actualizado. | - - ---- - -### DELETE `/api/model-enrollment` - -Este endpoint permite gestionar el enrolamiento de modelos en una marca. Actualmente, el servicio está disponible exclusivamente para **Mastercard**. - ---- - -#### **Request** - -```json - -{ - "reason": "DATA_ENTRY_ERROR", - "subscription_id": "349", - "uuid": "692b1ce4-7979-4b62-9bab-bda8ad8aa64b" -} - -``` - -| Campo | Tipo | Descripción | -|---------------------|----------|---------------------------------------------------------------| -| **reason** | `string` | Razón para eliminar el registro. Ejemplo: `DATA_ENTRY_ERROR`. | -| **subscription_id** | `string` | ID de la suscripción asociada al registro. | -| **uuid** | `string` | Identificador único del registro que se desea eliminar. | - - -#### **Response** - -```json - -{ - "message": "The record was successfully deleted" -} - -```