refacil-pay-mcp 1.1.4 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -12
- package/dist/config.d.ts +1 -0
- package/dist/config.js +2 -0
- package/dist/config.js.map +1 -1
- package/dist/core/resources.js +25 -18
- package/dist/core/resources.js.map +1 -1
- package/dist/core/tools.d.ts +1 -1
- package/dist/core/tools.js +38 -35
- package/dist/core/tools.js.map +1 -1
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/core/tools.js
CHANGED
|
@@ -99,7 +99,7 @@ const auth_loginInputValidator = z.object(auth_loginInputShape);
|
|
|
99
99
|
export const auth_loginTool = {
|
|
100
100
|
name: 'auth_login',
|
|
101
101
|
description: "To make the request and obtain the login you must have very clear your username and password for each environment where you are going to perform the integration, this information should be requested to our support team ([soportetecnico@refacil.com](https://mailto:soportetecnico@refacil.co)).\\n\\nWithin the post you will see below are the fields to make your request\\n\\n> Note that for the consumption of any of the API services it is necessary to send the authentication token that you get when consuming the **auth/login** service as an Authorization indicating the Type and Token. \\nThe authentication token does not expire. However, if at any time it were to expire, it will be necessary to generate a new authentication token. This could occur due to internal security measures that lead to manual or mass expiration of the token.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **username** \\\\* | string | User |\\n| **password** \\\\* | string | Password |\n\nContexto: Endpoint: POST /auth/login | Autenticación > Auth > Login | Uso: Genera un token JWT usando las credenciales configuradas en el MCP\n\n⚠️ IMPORTANTE: Esta herramienta SOLO debe usarse cuando sea necesario generar o renovar un token. Las credenciales se obtienen automáticamente de la configuración del servidor MCP. NO solicites credenciales al usuario.",
|
|
102
|
-
inputSchema:
|
|
102
|
+
inputSchema: auth_loginInputJsonSchema,
|
|
103
103
|
jsonSchema: auth_loginInputJsonSchema,
|
|
104
104
|
endpoint: '/auth/login',
|
|
105
105
|
method: 'POST',
|
|
@@ -161,8 +161,8 @@ const trx_token_generateInputValidator = z.object(trx_token_generateInputShape);
|
|
|
161
161
|
// Herramienta: trx_token_generate
|
|
162
162
|
export const trx_token_generateTool = {
|
|
163
163
|
name: 'trx_token_generate',
|
|
164
|
-
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n
|
|
165
|
-
inputSchema:
|
|
164
|
+
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **service** \\\\* | string | Value of the service to be consumed |\n\nContexto: Endpoint: POST /trx-token/generate | Trx token > Generate\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
165
|
+
inputSchema: trx_token_generateInputJsonSchema,
|
|
166
166
|
jsonSchema: trx_token_generateInputJsonSchema,
|
|
167
167
|
endpoint: '/trx-token/generate',
|
|
168
168
|
method: 'POST',
|
|
@@ -221,8 +221,8 @@ const transactional_token_methodInputValidator = z.object(transactional_token_me
|
|
|
221
221
|
// Herramienta: transactional_token_method
|
|
222
222
|
export const transactional_token_methodTool = {
|
|
223
223
|
name: 'transactional_token_method',
|
|
224
|
-
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n
|
|
225
|
-
inputSchema:
|
|
224
|
+
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **service** \\\\* | string | Value of the service to be consumed |\n\nContexto: Endpoint: POST /trx-token/generate | Trx token > Generate\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
225
|
+
inputSchema: transactional_token_methodInputJsonSchema,
|
|
226
226
|
jsonSchema: transactional_token_methodInputJsonSchema,
|
|
227
227
|
endpoint: '/trx-token/generate',
|
|
228
228
|
method: 'POST',
|
|
@@ -281,8 +281,8 @@ const transactional_token_withdrawInputValidator = z.object(transactional_token_
|
|
|
281
281
|
// Herramienta: transactional_token_withdraw
|
|
282
282
|
export const transactional_token_withdrawTool = {
|
|
283
283
|
name: 'transactional_token_withdraw',
|
|
284
|
-
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n
|
|
285
|
-
inputSchema:
|
|
284
|
+
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **service** \\\\* | string | Value of the service to be consumed |\n\nContexto: Endpoint: POST /trx-token/generate | Trx token > Generate\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
285
|
+
inputSchema: transactional_token_withdrawInputJsonSchema,
|
|
286
286
|
jsonSchema: transactional_token_withdrawInputJsonSchema,
|
|
287
287
|
endpoint: '/trx-token/generate',
|
|
288
288
|
method: 'POST',
|
|
@@ -341,8 +341,8 @@ const transactional_token_merchan_key_createInputValidator = z.object(transactio
|
|
|
341
341
|
// Herramienta: transactional_token_merchan_key_create
|
|
342
342
|
export const transactional_token_merchan_key_createTool = {
|
|
343
343
|
name: 'transactional_token_merchan_key_create',
|
|
344
|
-
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n
|
|
345
|
-
inputSchema:
|
|
344
|
+
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **service** \\\\* | string | Value of the service to be consumed |\n\nContexto: Endpoint: POST /trx-token/generate | Trx token > Generate\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
345
|
+
inputSchema: transactional_token_merchan_key_createInputJsonSchema,
|
|
346
346
|
jsonSchema: transactional_token_merchan_key_createInputJsonSchema,
|
|
347
347
|
endpoint: '/trx-token/generate',
|
|
348
348
|
method: 'POST',
|
|
@@ -401,8 +401,8 @@ const transactional_token_merchant_key_cancelInputValidator = z.object(transacti
|
|
|
401
401
|
// Herramienta: transactional_token_merchant_key_cancel
|
|
402
402
|
export const transactional_token_merchant_key_cancelTool = {
|
|
403
403
|
name: 'transactional_token_merchant_key_cancel',
|
|
404
|
-
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n
|
|
405
|
-
inputSchema:
|
|
404
|
+
description: "This service allows security validation for the execution of a transaction on the platform, generating a single-use token.\\n\\n> The transactional token service is obtained in three ways, depending on the action to be performed. For this, the value sent in the _**service**_ parameter must be set according to what is required: \\n1\\\\. For Payment Link: **“/cash-in/generate/payment-link/token”**. \\n2\\\\. For Payment method: **“/cash-in/generate/payment-method/token”**. \\n3\\\\. For Withdraw: **“/cash-out/generate/withdraw-method/token”**. \\n4\\\\. For Merchant Key: \\\\[ “/merchant-key/create”, “/merchant-key/cancel” \\\\] \\n \\n> The generated token is single-use for each transaction and cannot be consumed more than once. In addition, the transactional token will be valid for 60 seconds.\\n\\n | **Name** | **Type** | **Description** |\\n| --- | --- | --- |\\n| **service** \\\\* | string | Value of the service to be consumed |\n\nContexto: Endpoint: POST /trx-token/generate | Trx token > Generate\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
405
|
+
inputSchema: transactional_token_merchant_key_cancelInputJsonSchema,
|
|
406
406
|
jsonSchema: transactional_token_merchant_key_cancelInputJsonSchema,
|
|
407
407
|
endpoint: '/trx-token/generate',
|
|
408
408
|
method: 'POST',
|
|
@@ -527,7 +527,7 @@ const cash_in_generate_payment_link_tokenInputValidator = z.object(cash_in_gener
|
|
|
527
527
|
export const cash_in_generate_payment_link_tokenTool = {
|
|
528
528
|
name: 'cash_in_generate_payment_link_token',
|
|
529
529
|
description: "With the following request you can obtain a payment resource with a link that will redirect your customer to the payment gateway where he will see a list of the different payment methods available.\\n\\n ## 📥 Request Body Parameters\\n\\n| **Field** | **Type** | **Required** | **Description** |\\n| --- | --- | --- | --- |\\n| \\`amount\\` | number | ✅ | Value of the payment. |\\n| \\`brandId\\` | number | ❌ | ID of the customer\\'s white label; if one is not available, the default ID 79 is sent. |\\n| \\`expiresIn\\` | number | ❌ | Time in minutes for the expiration of the resource or payment link. |\\n| \\`reference1\\` | string | ✅ | Customer identifier, must be between 1 and 30 characters. |\\n| \\`reference2\\` | object | ❌ | Object for additional information. |\\n| \\`reference2.Commerce\\` | object | ❌ | Object for information related to the store or commerce. |\\n| \\`reference2.Data\\` | object | ❌ | Object for information related to the conciliation of the transaction. |\\n| \\`reference2.Label\\` | object | ❌ | Object to send information to be displayed in the payment summary. |\\n| \\`returnUrl\\` | string | ❌ | Link that the customer will see when clicking on the back to commerce button. |\\n| \\`showSummary\\` | boolean | ❌ | Indicates whether the RefácilPay payment summary will be shown or not (false: do not show, true: show). Default: true. |\\n| \\`userMetadata\\` | object | ✅ | Object containing key details about the user or merchant generating the payment resource. |\\n| \\`userMetadata.identifier\\` | string | ✅ | Unique identifier of the user or merchant generating the payment resource (max 36 characters). |\\n| \\`userMetadata.ip\\` | string | ✅ | IP address associated with the user\\'s identifier. Must be a valid IP address. |\\n| \\`userMetadata.urlCommerce\\` | string | ✅ | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\\n| \\`webhookUrl\\` | string | ✅ | URL of the client\\'s webhook to receive real-time payment status updates. |\\n\n\nContexto: Endpoint: POST /cash-in/generate/payment-link/token | Cash in > Generate > Payment link > Token\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
530
|
-
inputSchema:
|
|
530
|
+
inputSchema: cash_in_generate_payment_link_tokenInputJsonSchema,
|
|
531
531
|
jsonSchema: cash_in_generate_payment_link_tokenInputJsonSchema,
|
|
532
532
|
endpoint: '/cash-in/generate/payment-link/token',
|
|
533
533
|
method: 'POST',
|
|
@@ -680,8 +680,8 @@ const cash_in_generate_payment_method_tokenInputValidator = z.object(cash_in_gen
|
|
|
680
680
|
// Herramienta: cash_in_generate_payment_method_token
|
|
681
681
|
export const cash_in_generate_payment_method_tokenTool = {
|
|
682
682
|
name: 'cash_in_generate_payment_method_token',
|
|
683
|
-
description: "This endpoint allows you to **generate payment requests** through the available _cash-in_ methods.\\n\\n---\\n\\n### 💡 Overview\\n\\nThe table below lists the available payment methods along with their corresponding IDs and **minimum expiration times** (\\`expiresIn\\`) required when creating a payment request.\\n\\n| **Method ID** | **Description** | **Minimum Expiration (seconds)** |\\n| --- | --- | --- |\\n| \\`130\\` | Cash-in via **Nequi** | 43,200 |\\n| \\`131\\` | Cash-in via **Daviplata** | 43,200 |\\n| \\`133\\` | Cash-in via **PSE** | 1,800 |\\n| \\`262\\` | Cash-in via **PSE Gateway** | 1,800 |\\n| \\`134\\` | Cash-in via **IPay** | 43,200 |\\n| \\`153\\` | Cash-in via **Recaudo Efectivo** | 86,400 |\\n| \\`155\\` | Cash-in via **Transfiya Recaudo** | 43,200 |\\n| \\`163\\` | Cash-in via **TPaga** | 43,200 |\\n| \\`248\\` | Cash-in via **QR Interoperable** | N/A |\\n\\n> ⚠ **Important:** \\nThe value provided in the \\`expiresIn\\` field **must be greater than or equal** to the minimum expiration defined for the selected payment method. \\n \\n\\n---\\n\\n## 🧩 Payment Method Details\\n\\nEach payment method requires a specific object structure within the \\`\\\"paymentMethod\\\"\\` field.\\n\\n---\\n\\n### **Nequi**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 130,\\n \\\"cellphone\\\": \\\"3105293225\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Daviplata**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 131,\\n \\\"cellphone\\\": \\\"3208385715\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **PSE**\\n\\nFor this payment method, depending on the \\`typePerson\\` selected, only specific document types are accepted:\\n\\n- **\\`typePerson\\`****:** **\\`\\\"0\\\"\\`** → corresponds to a **Natural Person** and only accepts the following values for \\`documentType\\`:\\n \\n - \\`RCN\\`\\n \\n - \\`TI\\`\\n \\n - \\`CC\\`\\n \\n - \\`TE\\`\\n \\n - \\`CE\\`\\n \\n - \\`PA\\`\\n \\n - \\`DIE\\`\\n \\n- **\\`typePerson\\`****:** **\\`\\\"1\\\"\\`** → corresponds to a **Legal Person** and only accepts the following value for \\`documentType\\`:\\n \\n - \\`NIT\\`\\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 133,\\n \\\"documentType\\\": \\\"CC\\\",\\n \\\"typePerson\\\": \\\"0\\\",\\n \\\"bankId\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"name\\\": \\\"string\\\",\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"address\\\": \\\"string\\\",\\n \\\"email\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **PSE Gateway**\\n\\nThis payment method enables direct integration with the PSE network for processing online bank payments. \\nTo consume this product, it is required to have the following parameters previously configured and associated with your product:\\n\\n- \\`entity_code\\`\\n \\n- \\`service_code\\`\\n \\n- \\`company_ciiu\\`\\n \\n- \\`company_name\\`\\n \\n\\nThese parameters identify your company within the PSE network and are necessary for successful transaction routing and validation.\\n\\n> 💬 **For more information or to request these credentials, please contact the support team.** \\n \\n\\nThis method follows **the same structure and validation rules** as **PSE**, but must use the following identifier:\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 262,\\n \\\"documentType\\\": \\\"CC\\\",\\n \\\"typePerson\\\": \\\"0\\\",\\n \\\"bankId\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"name\\\": \\\"string\\\",\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"address\\\": \\\"string\\\",\\n \\\"email\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\nThe **PSE integration** relies heavily on the correct configuration of the \\`showSummary\\` and \\`returnUrl\\` parameters. \\nThese parameters control the **user experience** and the **finalization flow** of the payment process.\\n\\n| Scenario | \\`showSummary\\` | \\`returnUrl\\` | Flow Description |\\n| --- | --- | --- | --- |\\n| **1\\\\. Standard Redirect (Default)** | \\`true\\` or not sent | ✅ Present | Displays a transaction summary screen with key payment details and retrieves the final transaction status. After the payment is completed, the user is redirected to the specified \\`returnUrl\\`. |\\n| **2\\\\. Without Transaction Summary Screen** | \\`false\\` | ✅ Present | Skips the transaction summary screen and redirects the user directly to the \\`returnUrl\\`. In this case, the merchant’s system must display the transaction summary on the destination page. |\\n\\n> ⚠️ **Note:** \\nFor **PSE** and **PSE Gateway**, it is **strongly recommended** to use \\`showSummary: true\\` along with a valid \\`returnUrl\\` to ensure a seamless customer experience and accurate transaction tracking. \\n \\n> 🔗 **See also:** \\n \\n\\n- [Transaction Summary](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#45e0d76a-fabd-442e-9b17-e2f6b8354ec5)\\n \\n- [Transaction Status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799)\\n \\n\\n---\\n\\n### **IPay**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 134\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Recaudo Efectivo**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 153\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Transfiya Recaudo**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 155,\\n \\\"cellphone\\\": \\\"3105293225\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **TPaga**\\n\\nThis payment method supports an optional parameter called \\`isQr\\`, which determines the type of resource returned in the \\`url\\` field:\\n\\n| **Value** | **Description** |\\n| --- | --- |\\n| \\`true\\` | The \\`url\\` field returns a link to a **QR code** displaying transaction details. |\\n| \\`false\\` | The \\`url\\` field returns a **deeplink** to open directly in the TPAGA wallet app. |\\n\\n> 🧠 **Behavior:** \\nIf \\`isQr\\` is not provided, the default behavior is equivalent to \\`isQr: false\\`. \\nTransactions can only be completed **from a mobile device**. \\nIf the request is made from a desktop or tablet, it is recommended to send \\`isQr: true\\` so the user can scan the QR from a mobile device. \\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 163,\\n \\\"isQr\\\": false\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **QR Interoperable**\\n\\nFor this method, the following fields are **optional**:\\n\\n- \\`cellphone\\`\\n \\n- \\`documentNumber\\`\\n \\n- \\`documentType\\`\\n \\n- \\`merchantId\\`\\n \\n\\nThe service can function using only the payment method ID; however, providing these optional fields can **improve response time**. \\nYou may retrieve this data through the \\`enrollment-data\\` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\\n\\n> ⚠ **Prerequisite:** \\nThe merchant must complete the **Merchant Enrollment** process before using this method. \\nSee the _Merchant Enrollment_ section for setup details. \\n \\n> 🔁 **Open Resource:** \\nThe **QR Interoperable** operates as an _open resource_, meaning the generated QR can be used multiple times by the same user. \\n \\n> ⚙️ **Technical Note — Dynamic QR Behavior:** \\nDynamic QR codes may be scanned multiple times due to current limitations in the Redeban system. \\nThis is **not** an error in our platform. \\n \\n\\n#### Behavior Details\\n\\n- Redeban does not automatically invalidate a dynamic QR after its first scan.\\n \\n- As a result, the same QR may generate multiple transaction records.\\n \\n\\n#### Recommendations\\n\\n- Implement **application-level validation** to detect multiple payments from the same QR code.\\n \\n- Monitor dynamic QR transactions and confirm status before marking payments as completed.\\n \\n- Inform end-users to verify the success of a transaction before rescanning.\\n \\n\\n#### Future Considerations\\n\\n- Redeban is evaluating support for **single-use dynamic QR control**.\\n \\n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 248,\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"documentType\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"merchantId\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n## 📥 Request Body Parameters\\n\\n| **Field** | **Type** | **Required** | **Description** |\\n| --- | --- | --- | --- |\\n| \\`amount\\` | number | ✅ | Value of the payment. |\\n| \\`brandId\\` | number | ❌ | ID of the customer\\'s white label; if one is not available, the default ID 79 is sent. |\\n| \\`expiresIn\\` | number | ❌ | Time in seconds for the expiration of the resource or payment link. |\\n| \\`paymentMethod\\` | object | ✅ | Object specifying the payment method and its details. |\\n| \\`paymentMethod.id\\` | number | ✅ | ID of the selected payment method (see available payment methods). |\\n| \\`reference1\\` | string | ✅ | Customer identifier, must be between 1 and 30 characters. |\\n| \\`reference2\\` | object | ❌ | Object for additional information. |\\n| \\`reference2.Commerce\\` | object | ❌ | Object for information related to the store or commerce. |\\n| \\`reference2.Data\\` | object | ❌ | Object for information related to the conciliation of the transaction. |\\n| \\`reference2.Label\\` | object | ❌ | Object to send information to be displayed in the payment summary. |\\n| \\`returnUrl\\` | string | ❌ | Link that the customer will see when clicking on the back to commerce button. |\\n| \\`showSummary\\` | boolean | ❌ | Indicates whether the RefácilPay payment summary will be shown or not (false: do not show, true: show). Default: true. |\\n| \\`userMetadata\\` | object | ✅ | Object containing key details about the user or merchant generating the payment resource. |\\n| \\`userMetadata.identifier\\` | string | ✅ | Unique identifier of the user or merchant generating the payment resource (max 36 characters). |\\n| \\`userMetadata.ip\\` | string | ✅ | IP address associated with the user\\'s identifier. Must be a valid IP address. |\\n| \\`userMetadata.urlCommerce\\` | string | ✅ | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\\n| \\`webhookUrl\\` | string | ✅ | URL of the client\\'s webhook to receive real-time payment status updates. |\n\nContexto: Endpoint: POST /cash-in/generate/payment-method/token | Cash in > Generate > Payment method > Token\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
684
|
-
inputSchema:
|
|
683
|
+
description: "This endpoint allows you to **generate payment requests** through the available _cash-in_ methods.\\n\\n---\\n\\n### 💡 Overview\\n\\nThe table below lists the available payment methods along with their corresponding IDs and **minimum expiration times** (\\`expiresIn\\`) required when creating a payment request.\\n\\n| **Method ID** | **Description** | **Minimum Expiration (seconds)** |\\n| --- | --- | --- |\\n| \\`130\\` | Cash-in via **Nequi** | 43,200 |\\n| \\`131\\` | Cash-in via **Daviplata** | 43,200 |\\n| \\`133\\` | Cash-in via **PSE** | 1,800 |\\n| \\`262\\` | Cash-in via **PSE Gateway** | 1,800 |\\n| \\`134\\` | Cash-in via **IPay** | 43,200 |\\n| \\`153\\` | Cash-in via **Recaudo Efectivo** | 86,400 |\\n| \\`155\\` | Cash-in via **Transfiya Recaudo** | 43,200 |\\n| \\`163\\` | Cash-in via **TPaga** | 43,200 |\\n| \\`248\\` | Cash-in via **QR Interoperable** | N/A |\\n| \\`250\\` | Cash-in via **Llaves Bre-B** | 300 |\\n\\n> ⚠ **Important:** \\nThe value provided in the expiresIn field **must be greater than or equal** to the minimum expiration defined for the selected payment method. **This does not apply to dynamic keys, which always expire 5 minutes after creation.** \\n \\n\\n---\\n\\n## 🧩 Payment Method Details\\n\\nEach payment method requires a specific object structure within the \\`\\\"paymentMethod\\\"\\` field.\\n\\n---\\n\\n### **Nequi**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 130,\\n \\\"cellphone\\\": \\\"3105293225\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Daviplata**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 131,\\n \\\"cellphone\\\": \\\"3208385715\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **PSE**\\n\\nFor this payment method, depending on the \\`typePerson\\` selected, only specific document types are accepted:\\n\\n- **\\`typePerson\\`****:** **\\`\\\"0\\\"\\`** → corresponds to a **Natural Person** and only accepts the following values for \\`documentType\\`:\\n \\n - \\`RCN\\`\\n \\n - \\`TI\\`\\n \\n - \\`CC\\`\\n \\n - \\`TE\\`\\n \\n - \\`CE\\`\\n \\n - \\`PA\\`\\n \\n - \\`DIE\\`\\n \\n- **\\`typePerson\\`****:** **\\`\\\"1\\\"\\`** → corresponds to a **Legal Person** and only accepts the following value for \\`documentType\\`:\\n \\n - \\`NIT\\`\\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 133,\\n \\\"documentType\\\": \\\"CC\\\",\\n \\\"typePerson\\\": \\\"0\\\",\\n \\\"bankId\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"name\\\": \\\"string\\\",\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"address\\\": \\\"string\\\",\\n \\\"email\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **PSE Gateway**\\n\\nThis payment method enables direct integration with the PSE network for processing online bank payments. \\nTo consume this product, it is required to have the following parameters previously configured and associated with your product:\\n\\n- \\`entity_code\\`\\n \\n- \\`service_code\\`\\n \\n- \\`company_ciiu\\`\\n \\n- \\`company_name\\`\\n \\n\\nThese parameters identify your company within the PSE network and are necessary for successful transaction routing and validation.\\n\\n> 💬 **For more information or to request these credentials, please contact the support team.** \\n \\n\\nThis method follows **the same structure and validation rules** as **PSE**, but must use the following identifier:\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 262,\\n \\\"documentType\\\": \\\"CC\\\",\\n \\\"typePerson\\\": \\\"0\\\",\\n \\\"bankId\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"name\\\": \\\"string\\\",\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"address\\\": \\\"string\\\",\\n \\\"email\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\nThe **PSE integration** relies heavily on the correct configuration of the \\`showSummary\\` and \\`returnUrl\\` parameters. \\nThese parameters control the **user experience** and the **finalization flow** of the payment process.\\n\\n| Scenario | \\`showSummary\\` | \\`returnUrl\\` | Flow Description |\\n| --- | --- | --- | --- |\\n| **1\\\\. Standard Redirect (Default)** | \\`true\\` or not sent | ✅ Present | Displays a transaction summary screen with key payment details and retrieves the final transaction status. After the payment is completed, the user is redirected to the specified \\`returnUrl\\`. |\\n| **2\\\\. Without Transaction Summary Screen** | \\`false\\` | ✅ Present | Skips the transaction summary screen and redirects the user directly to the \\`returnUrl\\`. In this case, the merchant’s system must display the transaction summary on the destination page. |\\n\\n> ⚠️ **Note:** \\nFor **PSE** and **PSE Gateway**, it is **strongly recommended** to use \\`showSummary: true\\` along with a valid \\`returnUrl\\` to ensure a seamless customer experience and accurate transaction tracking. \\n \\n> 🔗 **See also:** \\n \\n\\n- [Transaction Summary](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#45e0d76a-fabd-442e-9b17-e2f6b8354ec5)\\n \\n- [Transaction Status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799)\\n \\n\\n---\\n\\n### **IPay**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 134\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Recaudo Efectivo**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 153\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Transfiya Recaudo**\\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 155,\\n \\\"cellphone\\\": \\\"3105293225\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **TPaga**\\n\\nThis payment method supports an optional parameter called \\`isQr\\`, which determines the type of resource returned in the \\`url\\` field:\\n\\n| **Value** | **Description** |\\n| --- | --- |\\n| \\`true\\` | The \\`url\\` field returns a link to a **QR code** displaying transaction details. |\\n| \\`false\\` | The \\`url\\` field returns a **deeplink** to open directly in the TPAGA wallet app. |\\n\\n> 🧠 **Behavior:** \\nIf \\`isQr\\` is not provided, the default behavior is equivalent to \\`isQr: false\\`. \\nTransactions can only be completed **from a mobile device**. \\nIf the request is made from a desktop or tablet, it is recommended to send \\`isQr: true\\` so the user can scan the QR from a mobile device. \\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 163,\\n \\\"isQr\\\": false\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **QR Interoperable**\\n\\nFor this method, the following fields are **optional**:\\n\\n- \\`cellphone\\`\\n \\n- \\`documentNumber\\`\\n \\n- \\`documentType\\`\\n \\n- \\`merchantId\\`\\n \\n\\nThe service can function using only the payment method ID; however, providing these optional fields can **improve response time**. \\nYou may retrieve this data through the \\`enrollment-data\\` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\\n\\n> ⚠ **Prerequisite:** \\nThe merchant must complete the **Merchant Enrollment** process before using this method. \\nSee the _Merchant Enrollment_ section for setup details. \\n \\n> 🔁 **Open Resource:** \\nThe **QR Interoperable** operates as an _open resource_, meaning the generated QR can be used multiple times by the same user. \\n \\n> ⚙️ **Technical Note — Dynamic QR Behavior:** \\nDynamic QR codes may be scanned multiple times due to current limitations in the Redeban system. \\nThis is **not** an error in our platform. \\n \\n\\n#### Behavior Details\\n\\n- Redeban does not automatically invalidate a dynamic QR after its first scan.\\n \\n- As a result, the same QR may generate multiple transaction records.\\n \\n\\n#### Recommendations\\n\\n- Implement **application-level validation** to detect multiple payments from the same QR code.\\n \\n- Monitor dynamic QR transactions and confirm status before marking payments as completed.\\n \\n- Inform end-users to verify the success of a transaction before rescanning.\\n \\n\\n#### Future Considerations\\n\\n- Redeban is evaluating support for **single-use dynamic QR control**.\\n \\n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 248,\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"documentType\\\": \\\"string\\\",\\n \\\"documentNumber\\\": \\\"string\\\",\\n \\\"merchantId\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n### **Llaves** Dinámicas **Bre-B**\\n\\nFor this method, the following fields are **required**:\\n\\n- \\`cellphone\\`\\n \\n- \\`docNumber\\`\\n \\n- \\`docType\\`\\n \\n- \\`merchantId\\`\\n \\n\\nYou may retrieve this data through the \\`enrollment-data\\` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\\n\\n> ⚠ **Prerequisite:** \\nThe merchant must complete the **Merchant Enrollment** process before using this method. \\nSee the _Merchant Enrollment_ section for setup details. \\n \\n> 🔁 **Open Resource:** \\nThe **Llaves Dinamicas Bre-B** operates as an _open resource_, meaning the generated KEY can be used multiple times by the same user. \\n \\n> ⚙️ **Technical Note — Dynamic Key Behavior:** \\nDynamic keys may receive multiple money transfers due to current limitations in the Redeban system. \\nThis behavior does not represent an error or malfunction in our platform. \\n**Additionally, dynamic keys have a fixed validity period of 5 minutes, and this duration cannot be modified.** \\n \\n\\n#### Behavior Details\\n\\n- Redeban does not automatically invalidate a dynamic KEY after its first send.\\n \\n- As a result, the same KEY may generate multiple transaction records.\\n \\n\\n#### Recommendations\\n\\n- Implement **application-level validation** to detect multiple payments from the same KEY.\\n \\n- Monitor dynamic KEY transactions and confirm status before marking payments as completed.\\n \\n- Inform end-users to verify the success of a transaction before rescanning.\\n \\n\\n#### Future Considerations\\n\\n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\\n \\n\\n\\`\\`\\` json\\n\\\"paymentMethod\\\": {\\n \\\"id\\\": 250,\\n \\\"cellphone\\\": \\\"string\\\",\\n \\\"docType\\\": \\\"string\\\",\\n \\\"docNumber\\\": \\\"string\\\",\\n \\\"merchantId\\\": \\\"string\\\"\\n}\\n\\n \\`\\`\\`\\n\\n---\\n\\n## 📥 Request Body Parameters\\n\\n| **Field** | **Type** | **Required** | **Description** |\\n| --- | --- | --- | --- |\\n| \\`amount\\` | number | ✅ | Value of the payment. |\\n| \\`brandId\\` | number | ❌ | ID of the customer\\'s white label; if one is not available, the default ID 79 is sent. |\\n| \\`expiresIn\\` | number | ❌ | Time in seconds for the expiration of the resource or payment link. |\\n| \\`paymentMethod\\` | object | ✅ | Object specifying the payment method and its details. |\\n| \\`paymentMethod.id\\` | number | ✅ | ID of the selected payment method (see available payment methods). |\\n| \\`reference1\\` | string | ✅ | Customer identifier, must be between 1 and 30 characters. |\\n| \\`reference2\\` | object | ❌ | Object for additional information. |\\n| \\`reference2.Commerce\\` | object | ❌ | Object for information related to the store or commerce. |\\n| \\`reference2.Data\\` | object | ❌ | Object for information related to the conciliation of the transaction. |\\n| \\`reference2.Label\\` | object | ❌ | Object to send information to be displayed in the payment summary. |\\n| \\`returnUrl\\` | string | ❌ | Link that the customer will see when clicking on the back to commerce button. |\\n| \\`showSummary\\` | boolean | ❌ | Indicates whether the RefácilPay payment summary will be shown or not (false: do not show, true: show). Default: true. |\\n| \\`userMetadata\\` | object | ✅ | Object containing key details about the user or merchant generating the payment resource. |\\n| \\`userMetadata.identifier\\` | string | ✅ | Unique identifier of the user or merchant generating the payment resource (max 36 characters). |\\n| \\`userMetadata.ip\\` | string | ✅ | IP address associated with the user\\'s identifier. Must be a valid IP address. |\\n| \\`userMetadata.urlCommerce\\` | string | ✅ | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\\n| \\`webhookUrl\\` | string | ✅ | URL of the client\\'s webhook to receive real-time payment status updates. |\n\nContexto: Endpoint: POST /cash-in/generate/payment-method/token | Cash in > Generate > Payment method > Token\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
684
|
+
inputSchema: cash_in_generate_payment_method_tokenInputJsonSchema,
|
|
685
685
|
jsonSchema: cash_in_generate_payment_method_tokenInputJsonSchema,
|
|
686
686
|
endpoint: '/cash-in/generate/payment-method/token',
|
|
687
687
|
method: 'POST',
|
|
@@ -783,8 +783,8 @@ const cash_out_generate_withdraw_method_tokenInputJsonSchema = {
|
|
|
783
783
|
"type": "object",
|
|
784
784
|
"description": "Campo del body: withdrawMethod",
|
|
785
785
|
"default": {
|
|
786
|
-
"id":
|
|
787
|
-
"
|
|
786
|
+
"id": 264,
|
|
787
|
+
"key": "@REPRUEBAL7717"
|
|
788
788
|
}
|
|
789
789
|
},
|
|
790
790
|
"userMetadata": {
|
|
@@ -813,7 +813,7 @@ const cash_out_generate_withdraw_method_tokenInputValidator = z.object(cash_out_
|
|
|
813
813
|
export const cash_out_generate_withdraw_method_tokenTool = {
|
|
814
814
|
name: 'cash_out_generate_withdraw_method_token',
|
|
815
815
|
description: "This service allows you to generate withdrawal requests through the enabled dispersion means.\\n\\n> 🔐 Authentication \\n \\n\\nAll requests must include the following headers:\\n\\n| **Header** | **Description** | **Example** |\\n| --- | --- | --- |\\n| Authorization | Bearer token generated by the authentication service. | Bearer eyJhbGciOiJIUzI1NiIs... |\\n| x-transaction-token | Transactional token specific to the service. | 9b48edde-652d-11ed-984e-02c840fe**** |\\n| Content-Type | Content type of the request body. | application/json |\\n\\n> Important fields within the requests: \\nWebhook: This is the url of the client\\'s webhook to where our service sends the transaction status and transaction detail information.\\n\\n This endpoint allows you to **generate withdrawal (cash-out) requests** through the available payout methods.\\n\\n---\\n\\n### 💡 Overview\\n\\nThe table below lists the available payout methods along with their corresponding IDs and brief descriptions.\\n\\n| **Method ID** | **Description** |\\n| --- | --- |\\n| \\`245\\` | Cash-out via **Transfiya** |\\n| \\`264\\` | Cash-out via **Bre-B** |\\n\\n> ⚠ **Note:** \\nEach withdrawal method requires a specific object structure within the \\`\\\"withdrawMethod\\\"\\` field, as shown below. \\n \\n\\n---\\n\\n## 🧩 Payout Method Details\\n\\n### **Transfiya**\\n\\n\\`\\`\\` json\\n\\\"withdrawMethod\\\": {\\n \\\"id\\\": 245,\\n \\\"cellphone\\\": \\\"3125763074\\\"\\n}\\n\\n \\`\\`\\`\\n\\n**Description:** \\nTransfers funds to a recipient using their registered Transfiya cellphone number.\\n\\n> ⚠ **Important:** \\nEnsure the cellphone number is registered with Transfiya and capable of receiving funds. \\n \\n\\n---\\n\\n### **Bre-B**\\n\\n\\`\\`\\` json\\n\\\"withdrawMethod\\\": {\\n \\\"id\\\": 264,\\n \\\"key\\\": \\\"@REPRUEBAL7717\\\"\\n}\\n\\n \\`\\`\\`\\n\\n**Description:** \\nTransfers funds directly to a Bre-B account using the beneficiary’s unique Bre-B key.\\n\\n> 💡 **Tip:** \\nThe \\`key\\` field must contain a valid Bre-B account alias in the format \\`@USERNAME\\`. \\n \\n\\n---\\n\\n## 📥 Request Body Parameters\\n\\n| **Field** | **Type** | **Required** | **Description** |\\n| --- | --- | --- | --- |\\n| \\`amount\\` | number | ✅ | Amount to be withdrawn. |\\n| \\`reference1\\` | string | ✅ | Unique transaction reference generated by the client (max 20 characters). |\\n| \\`webhookRequest\\` | string | ✅ | Customer’s webhook URL to receive real-time withdrawal status updates. |\\n| \\`userMetadata\\` | object | ✅ | Object containing metadata related to the origin of the transaction. |\\n| \\`userMetadata.identifier\\` | string | ✅ | Identifier for the user or merchant initiating the transaction. |\\n| \\`userMetadata.ip\\` | string | ✅ | IP address from which the transaction was initiated. |\\n| \\`userMetadata.urlCommerce\\` | string | ✅ | Commerce or customer’s URL associated with the transaction. |\\n| \\`withdrawMethod\\` | object | ✅ | Object specifying the withdrawal method and destination details. |\\n| \\`withdrawMethod.id\\` | number | ✅ | ID of the selected payout method (see table above). |\\n| \\`withdrawMethod.cellphone\\` | string | Conditional | Required for **Transfiya** withdrawals. |\\n| \\`withdrawMethod.key\\` | string | Conditional | Required for **Bre-B** withdrawals. |\\n| \\`withdrawMethod.bankName\\` | string | ❌ | Optional bank name, if applicable for future payout methods. |\\n\\n---\n\nContexto: Endpoint: POST /cash-out/generate/withdraw-method/token | Cash out > Generate > Withdraw method > Token\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
816
|
-
inputSchema:
|
|
816
|
+
inputSchema: cash_out_generate_withdraw_method_tokenInputJsonSchema,
|
|
817
817
|
jsonSchema: cash_out_generate_withdraw_method_tokenInputJsonSchema,
|
|
818
818
|
endpoint: '/cash-out/generate/withdraw-method/token',
|
|
819
819
|
method: 'POST',
|
|
@@ -841,7 +841,7 @@ export const cash_out_generate_withdraw_method_tokenTool = {
|
|
|
841
841
|
const webhookRequestValue = args.webhookRequest !== undefined ? args.webhookRequest : "https://****gerstg.azure-api.net/SkCo.PagosEnLinea.API/payonline/PostStatus";
|
|
842
842
|
if (webhookRequestValue !== undefined)
|
|
843
843
|
bodyData.webhookRequest = webhookRequestValue;
|
|
844
|
-
const withdrawMethodValue = args.withdrawMethod !== undefined ? args.withdrawMethod : { "id":
|
|
844
|
+
const withdrawMethodValue = args.withdrawMethod !== undefined ? args.withdrawMethod : { "id": 264, "key": "@REPRUEBAL7717" };
|
|
845
845
|
if (withdrawMethodValue !== undefined)
|
|
846
846
|
bodyData.withdrawMethod = withdrawMethodValue;
|
|
847
847
|
const userMetadataValue = args.userMetadata !== undefined ? args.userMetadata : { "identifier": "1234567890", "ip": "127.0.0.1", "urlCommerce": "https://url-tucomercio.com" };
|
|
@@ -876,21 +876,22 @@ const customer_getbalanceInputJsonSchema = {
|
|
|
876
876
|
"type": "object",
|
|
877
877
|
"properties": {
|
|
878
878
|
"userId": {
|
|
879
|
-
"type": "
|
|
880
|
-
"description": "Campo del body: userId"
|
|
879
|
+
"type": "number",
|
|
880
|
+
"description": "Campo del body: userId",
|
|
881
|
+
"default": 1085718
|
|
881
882
|
}
|
|
882
883
|
},
|
|
883
884
|
"required": []
|
|
884
885
|
};
|
|
885
886
|
const customer_getbalanceInputShape = {
|
|
886
|
-
userId: z.
|
|
887
|
+
userId: z.number().optional().describe("Campo del body: userId")
|
|
887
888
|
};
|
|
888
889
|
const customer_getbalanceInputValidator = z.object(customer_getbalanceInputShape);
|
|
889
890
|
// Herramienta: customer_getbalance
|
|
890
891
|
export const customer_getbalanceTool = {
|
|
891
892
|
name: 'customer_getbalance',
|
|
892
|
-
description: "This service allows you to generate withdrawal requests through the enabled dispersion means.\\n\\n> 🔐 Authentication \\n \\n\\nAll requests must include the following headers:\\n\\n| **Header** | **Description** | **Example** |\\n| --- | --- | --- |\\n| Authorization | Bearer token generated by the authentication service. | Bearer eyJhbGciOiJIUzI1NiIs... |\\n| x-transaction-token | Transactional token specific to the service. | 9b48edde-652d-11ed-984e-02c840fe**** |\\n| Content-Type | Content type of the request body. | application/json |\\n\\n> Important fields within the requests: \\nWebhook: This is the url of the client\\'s webhook to where our service sends the transaction status and transaction detail information.\\n\\n This service allows you to consult the balance exchange and the dispersion exchange associated with the client\\'s identifier.\\n\\n> To use the service, an authentication token is required, which must be sent as an Authorization header. \\n \\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`userId
|
|
893
|
-
inputSchema:
|
|
893
|
+
description: "This service allows you to generate withdrawal requests through the enabled dispersion means.\\n\\n> 🔐 Authentication \\n \\n\\nAll requests must include the following headers:\\n\\n| **Header** | **Description** | **Example** |\\n| --- | --- | --- |\\n| Authorization | Bearer token generated by the authentication service. | Bearer eyJhbGciOiJIUzI1NiIs... |\\n| x-transaction-token | Transactional token specific to the service. | 9b48edde-652d-11ed-984e-02c840fe**** |\\n| Content-Type | Content type of the request body. | application/json |\\n\\n> Important fields within the requests: \\nWebhook: This is the url of the client\\'s webhook to where our service sends the transaction status and transaction detail information.\\n\\n This service allows you to consult the balance exchange and the dispersion exchange associated with the client\\'s identifier.\\n\\n> To use the service, an authentication token is required, which must be sent as an Authorization header. \\n \\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`userId (optional)\\` | number | Integrated unique user identifier |\n\nContexto: Endpoint: POST /customer/getBalance | Customer > GetBalance\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
894
|
+
inputSchema: customer_getbalanceInputJsonSchema,
|
|
894
895
|
jsonSchema: customer_getbalanceInputJsonSchema,
|
|
895
896
|
endpoint: '/customer/getBalance',
|
|
896
897
|
method: 'POST',
|
|
@@ -906,7 +907,9 @@ export const customer_getbalanceTool = {
|
|
|
906
907
|
const validatedInput = validateToolInput(customer_getbalanceInputValidator, argsToValidate);
|
|
907
908
|
const args = validatedInput;
|
|
908
909
|
const bodyData = {};
|
|
909
|
-
|
|
910
|
+
const userIdValue = args.userId !== undefined ? args.userId : 1085718;
|
|
911
|
+
if (userIdValue !== undefined)
|
|
912
|
+
bodyData.userId = userIdValue;
|
|
910
913
|
return await makeApiRequest('POST', '/customer/getBalance', bodyData, undefined, secretId);
|
|
911
914
|
}
|
|
912
915
|
catch (error) {
|
|
@@ -948,7 +951,7 @@ const payment_transfiya_banksInputValidator = z.object(payment_transfiya_banksIn
|
|
|
948
951
|
export const payment_transfiya_banksTool = {
|
|
949
952
|
name: 'payment_transfiya_banks',
|
|
950
953
|
description: "This service allows you to generate withdrawal requests through the enabled dispersion means.\\n\\n> 🔐 Authentication \\n \\n\\nAll requests must include the following headers:\\n\\n| **Header** | **Description** | **Example** |\\n| --- | --- | --- |\\n| Authorization | Bearer token generated by the authentication service. | Bearer eyJhbGciOiJIUzI1NiIs... |\\n| x-transaction-token | Transactional token specific to the service. | 9b48edde-652d-11ed-984e-02c840fe**** |\\n| Content-Type | Content type of the request body. | application/json |\\n\\n> Important fields within the requests: \\nWebhook: This is the url of the client\\'s webhook to where our service sends the transaction status and transaction detail information.\\n\\n This service allows you to consult the balance exchange and the dispersion exchange associated with the client\\'s identifier.\\n\\n> To use the service, an authentication token is required, which must be sent as an Authorization header. \\n \\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`cellphone\\`\\\\* | number | The cell phone number to be used to consult the list of banks. |\n\nContexto: Endpoint: POST /payment/transfiya-banks | Payment > Transfiya banks\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
951
|
-
inputSchema:
|
|
954
|
+
inputSchema: payment_transfiya_banksInputJsonSchema,
|
|
952
955
|
jsonSchema: payment_transfiya_banksInputJsonSchema,
|
|
953
956
|
endpoint: '/payment/transfiya-banks',
|
|
954
957
|
method: 'POST',
|
|
@@ -1008,7 +1011,7 @@ const payment_statusInputValidator = z.object(payment_statusInputShape);
|
|
|
1008
1011
|
export const payment_statusTool = {
|
|
1009
1012
|
name: 'payment_status',
|
|
1010
1013
|
description: "These services will allow us to validate the status of a transaction and consult the characteristics of a payment method.\\n\\n This service allows you to check the status of a transaction made, for this you must have the _reference_ data that returned the response when generating any payment resource.\\n\\nIn the response you will get the _status_ _id_ which will mean the following\\n\\n0 - Transaction Rejected\\n\\n1 - Pending Transaction\\n\\n2 - Transaction Approved\\n\\n3 - Failed Transaction\\n\\n5 - Transaction Cancelled\\n\\n9 - Processing Transaction\\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`reference\\`\\\\* | string | Product reference |\n\nContexto: Endpoint: POST /payment/status | Payment > Status\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1011
|
-
inputSchema:
|
|
1014
|
+
inputSchema: payment_statusInputJsonSchema,
|
|
1012
1015
|
jsonSchema: payment_statusInputJsonSchema,
|
|
1013
1016
|
endpoint: '/payment/status',
|
|
1014
1017
|
method: 'POST',
|
|
@@ -1068,7 +1071,7 @@ const payment_customer_reference_statusInputValidator = z.object(payment_custome
|
|
|
1068
1071
|
export const payment_customer_reference_statusTool = {
|
|
1069
1072
|
name: 'payment_customer_reference_status',
|
|
1070
1073
|
description: "These services will allow us to validate the status of a transaction and consult the characteristics of a payment method.\\n\\n ## 🔍 Check Transaction by Customer Reference\\n\\nThis endpoint allows **API Pay** users to query the status of a transaction using only the \\`customerReference\\` value originally provided when generating a resource as \\`reference1\\` through any of the following endpoints:\\n\\n- \\`/cash-in/generate/payment-link/token\\`\\n \\n- \\`/cash-in/generate/payment-method/token\\`\\n \\n- \\`/cash-out/generate/withdraw-method/token\\`\\n \\n\\nThis service is useful for retrieving the internal **Refacil** transaction information associated with a previously submitted customer reference.\\n\\n---\\n\\n## 🔐 Authentication\\n\\nThis endpoint **requires** a valid Bearer Token in the request headers. Requests without valid authentication will be rejected with an \\`Unauthorized\\` error.\\n\\n## 📤 Successful Response\\n\\n- \\`exists\\`: \\`true\\` indicates that the transaction associated with the provided \\`customerReference\\` was found.\\n \\n- \\`id\\`: Internal Refacil transaction ID.\\n \\n- \\`status\\`: Transaction status code (see table below).\\n \\n- \\`reference\\`: Full Refacil transaction reference, which can be used to query \\`/payment/status\\`.\\n \\n\\n### ℹ️ Status Code Reference\\n\\n| Status Code | Meaning |\\n| --- | --- |\\n| \\`0\\` | Transaction Rejected |\\n| \\`1\\` | Transaction Pending |\\n| \\`2\\` | Transaction Approved |\\n| \\`3\\` | Transaction Failed |\\n| \\`5\\` | Transaction Cancelled |\\n| \\`9\\` | Transaction Processing |\\n\\n---\n\nContexto: Endpoint: POST /payment/customer-reference/status | Payment > Customer reference > Status\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1071
|
-
inputSchema:
|
|
1074
|
+
inputSchema: payment_customer_reference_statusInputJsonSchema,
|
|
1072
1075
|
jsonSchema: payment_customer_reference_statusInputJsonSchema,
|
|
1073
1076
|
endpoint: '/payment/customer-reference/status',
|
|
1074
1077
|
method: 'POST',
|
|
@@ -1128,7 +1131,7 @@ const payment_featuresInputValidator = z.object(payment_featuresInputShape);
|
|
|
1128
1131
|
export const payment_featuresTool = {
|
|
1129
1132
|
name: 'payment_features',
|
|
1130
1133
|
description: "These services will allow us to validate the status of a transaction and consult the characteristics of a payment method.\\n\\n This service allows you to consult the necessary characteristics of a payment method to successfully generate a resource. For example, obtain the PSE banks\\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`id\\`\\\\* | integer | Product identification |\n\nContexto: Endpoint: POST /payment/features | Payment > Features\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1131
|
-
inputSchema:
|
|
1134
|
+
inputSchema: payment_featuresInputJsonSchema,
|
|
1132
1135
|
jsonSchema: payment_featuresInputJsonSchema,
|
|
1133
1136
|
endpoint: '/payment/features',
|
|
1134
1137
|
method: 'POST',
|
|
@@ -1188,7 +1191,7 @@ const webhook_notifyInputValidator = z.object(webhook_notifyInputShape);
|
|
|
1188
1191
|
export const webhook_notifyTool = {
|
|
1189
1192
|
name: 'webhook_notify',
|
|
1190
1193
|
description: "This component must be built by the merchant to receive the transaction notification data.\\n\\nYou must take into account the following steps:\\n\\n**1.**You must create a Webhook without authentication.\\n\\n**2\\\\. The** Url created will be the one you send in all requests when generating the payment resource in the “_WebhookUrl_” field. It is important to keep in mind that if for some reason you change the webhook you must modify the urls that you send in each generated resource.\\n\\n<img src=\\\"https://content.pstmn.io/10fdac74-e60a-41f2-b9ff-8b5777a7afc0/aW1hZ2UucG5n\\\" width=\\\"322\\\" height=\\\"117\\\">\\n\\nA signature must be generated to validate the integrity of the messages sent to the webhook and the fields must be concatenated in the following way:\\n\\n_**HASH_KEY**_ _\\\\=This data must be requested to the support area_.\\n\\n_**let signature**_ _\\\\= referenceId-resourceId-amount-updatedAt-HASH_KEY; signature = crypto.createHmac(“sha1”, HASH_KEY).update(signature).digest(“hex”);_\\n\\nExample of a response that will reach your Webhook\\n\\n**Response**\\n\\n\\`\\`\\` json\\n{\\n \\\"realAmount\\\": 20000,\\n \\\"amount\\\": 19405,\\n \\\"cost\\\": \\\"$595.00\\\",\\n \\\"referenceId\\\": \\\"38**\\\",\\n \\\"moduleId\\\": 9,\\n \\\"productId\\\": 117,\\n \\\"referenceKey\\\": \\\"3538d790-ae14-11ed-be2d-4d9b1bc987e6\\\",\\n \\\"paymentMethod\\\": \\\"PSE\\\",\\n \\\"userId\\\": 189067,\\n \\\"resourceId\\\": \\\"10024**\\\",\\n \\\"updatedAt\\\": \\\"2023-02-16 11:11:55\\\",\\n \\\"providerId\\\": 8,\\n \\\"providerReference\\\": \\\"3122330\\\",\\n \\\"reference1\\\": \\\"435sdfsd**\\\",\\n \\\"reference2\\\": {\\n \\\"Label\\\": {\\n \\\"Information\\\": \\\"Por seguridad algunos datos se encuentran cifrados\\\",\\n \\\"Name\\\": \\\"L**A\\\",\\n \\\"Email\\\": \\\"l**am@**\\\",\\n \\\"CellPhone\\\": \\\"3**4\\\",\\n \\\"DocumentType\\\": \\\"C\\\",\\n \\\"DocumentNumber\\\": \\\"52019859\\\",\\n \\\"Description\\\": \\\"Abono\\\",\\n \\\"Commerce\\\": \\\"Skandia\\\",\\n \\\"Reference1\\\": null,\\n \\\"Reference2\\\": null,\\n \\\"Reference3\\\": null\\n },\\n \\\"Data\\\": {\\n \\\"ConciliationCode\\\": \\\"FCO\\\",\\n \\\"ConciliationContract\\\": \\\"1277840\\\",\\n \\\"DocType\\\": \\\"N\\\",\\n \\\"DocNumber\\\": \\\"800194363\\\"\\n },\\n \\\"returnUrl\\\": \\\"https://www.google.com/\\\"\\n },\\n \\\"bankId\\\": \\\"1022\\\",\\n \\\"bankName\\\": \\\"BANCO UNION COLOMBIANO\\\",\\n \\\"status\\\": 2,\\n \\\"transfiyaStatus\\\": \\\"PENDING\\\",\\n \\\"sign\\\": \\\"aa2f472ad7e84524a02d1716b56fc16ec2a87***\\\",\\n \\\"error\\\": {\\n \\\"code\\\": \\\"20-07A\\\",\\n \\\"message\\\": \\\"Error técnico en Lambda\\\"\\n }\\n}\\n\\n \\`\\`\\`\\n\\n- Within the webhook an **\\\"error** ” object is sent that shows the error _**code**_ and _**message**_ associated with rejections received from the supplier/bank or cancellation of the transaction when the generation of the resource is not completed.\\n \\n- The error codes are printed when the transaction is _**Rejected**_ by the bank or when it is _**Cancelled**_ because the resource generation could not be completed.\\n \\n\\n**Notification for Withdraw**\\n\\nFor withdraws, a notification will be sent to the webhook provided in the application. This notification will follow the structure mentioned above and will additionally include the withdrawal data. An example is provided below:\\n\\n\\`\\`\\` json\\n{\\n ...\\\"webhook\\\",\\n \\\"withdraw\\\": {\\n \\\"id\\\": \\\"1403**\\\",\\n \\\"transactionId\\\": \\\"5690**\\\",\\n \\\"userId\\\": 189067,\\n \\\"providerReference\\\": \\\"3122330\\\",\\n \\\"accountNumber\\\": \\\"3051000002\\\",\\n \\\"accountId\\\": null,\\n \\\"createdAt\\\": \\\"2023-02-16 11:10:55\\\",\\n \\\"updatedAt\\\": \\\"2023-02-16 11:12:55\\\",\\n \\\"deletedAt\\\": null,\\n \\\"infoReference\\\": \\\"435sdfsd**\\\",\\n \\\"observation\\\": null\\n },\\n}\\n\\n \\`\\`\\`\\n\\n> _**The implementation of the webhook by the API user is mandatory. The reception and storage of the information for the reconciliation process by the API user with RefácilPay must be ensured.**__**This item will be evaluated during the certification process and will be mandatory for the transition to Production.**_\\n\\n Body\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| amount\\\\* | Integer | Total transaction value |\\n| cost\\\\* | Integer | Transaction cost |\\n| Resource | Object | Object |\\n| id | Integer | Identifier of the payment resource |\\n| updatedAt | String | Date and time at which the transaction was processed |\\n| status\\\\* | Object | Transaction status identifier |\\n| transfiyaStatus | String | The TransfiYa status, see the details below |\\n| id\\\\* | String | Transaction status ID : 1 Pending , 2 Approved ,3 Failed |\\n| id \\\\* | Integer | transaction identifier |\\n| description | String | Status detail |\\n| Key | interger | Key |\\n| PaymentMethod | Object | Payment method |\\n| id | String | Method identifier |\\n| name | String | payment method name |\\n| type | String | method |\\n| extra | Object | Object |\\n| reference1\\\\* | String | Unique reference to the transaction provided when sending the request to generate the resource |\\n| reference2 | String | Allows to append extra information provided by the client |\\n| reference3 | String | Allows to append extra information provided by the customer |\\n| commerceId | String | Commerce identifier |\\n| createdAt | String | Date and time the transaction was created |\\n| signature | String | Signature generated for webhook notification |\\n| data | Object | Object with all data |\\n| Transaction | String | |\\n\\n\\n## TransfiYa Status\\n\\n| **transfiyaStatus** | Description |\\n| --- | --- |\\n| \\`CREATED\\` | Transfer is received and queued for processing. |\\n| \\`PENDING\\` | Transfer is valid and is waiting for the target to accept it. |\\n| \\`ACCEPTED\\` | Transfer has been accepted by the target, and payment is pending in the target bank. |\\n| \\`COMPLETED\\` | The payment is valid and completely processed, visible in the receiving bank account. |\\n| \\`REJECTED\\` | Payment was rejected. |\\n| \\`ERROR\\` | An error occurred during payment. |\\n\\n### Transfer state machine\\n\\n<img src=\\\"https://content.pstmn.io/89f89557-2e1b-44c2-8dcb-d9e7d2f32c54/aW1hZ2UucG5n\\\" width=\\\"293\\\" height=\\\"380\\\">\n\nContexto: Endpoint: POST /webhook/notify | Webhook > Notify\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1191
|
-
inputSchema:
|
|
1194
|
+
inputSchema: webhook_notifyInputJsonSchema,
|
|
1192
1195
|
jsonSchema: webhook_notifyInputJsonSchema,
|
|
1193
1196
|
endpoint: '/webhook/notify',
|
|
1194
1197
|
method: 'POST',
|
|
@@ -1240,7 +1243,7 @@ const merchant_enrollmentInputValidator = z.object(merchant_enrollmentInputShape
|
|
|
1240
1243
|
export const merchant_enrollmentTool = {
|
|
1241
1244
|
name: 'merchant_enrollment',
|
|
1242
1245
|
description: "This service allows merchants to enroll for the use of the QR interoperable payment method and key creation.\\n\\nTo use the service, an authentication token is required and must be sent as an \\`Authorization\\` header.\\n\\n---\\n\\n### **Enrollment Process**\\n\\n1. **Merchant Enrollment**\\n \\n - Initiates the enrollment process. The enrollment can take up to **7 minutes** to complete.\\n \\n2. **Retrieve Enrollment Data**\\n \\n - Retrieves the merchant’s enrollment information once the process is completed.\\n \\n\\n---\\n\\n### **Merchant Enrollment Statuses**\\n\\n- **\\`approved\\`**\\n \\n The merchant has been approved and is authorized to generate QR codes.\\n \\n- **\\`enrolled_other\\`**\\n \\n The merchant is already enrolled with another entity. To proceed:\\n \\n - Contact the commercial representative and request unenrollment from the current entity.\\n \\n - Submit a letter signed by the legal representative.\\n \\n - Be aware that this process may take up to **5 business days**.\\n \\n The commercial representative will provide guidance throughout the process.\\n \\n- **\\`rejected\\`**\\n \\n The merchant has been rejected. Please contact your commercial representative for further details.\\n \\n- **\\`pending\\`**\\n \\n The enrollment is in progress. The query may take a few minutes. If a final status is not received shortly, contact **RefacilPay support** to verify the situation.\\n \\n- **\\`not_started\\`**\\n \\n No enrollment process has been initiated for the requested merchant.\\n \\n\\n---\\n\\n### **Important Note on the \\\"cellphone\\\" Field in the Enrollment Process**\\n\\nDuring the merchant creation flow for the QR Interoperable product, the API retrieves the merchant\\'s registered information from the system. However, for the **\\\"cellphone number\\\"** field, the **Refacil** system automatically replaces the merchant’s actual phone number with a **generic alias number**.\\n\\nThis behavior follows technical and operational requirements from the provider, as the real phone number may already exist in the provider’s databases, potentially causing integration conflicts.\\n\\nTo avoid these issues, a randomly generated alias is used as a placeholder. This alias is **exclusive to this product** and does **not affect** the merchant’s operation in other services.\\n\\n This endpoint initiates the merchant enrollment process required to use the QR interoperable payment method. Once the request is made, the enrollment process may take up to **7 minutes** to complete.\n\nContexto: Endpoint: GET /merchant/enrollment | Merchant > Enrollment\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1243
|
-
inputSchema:
|
|
1246
|
+
inputSchema: merchant_enrollmentInputJsonSchema,
|
|
1244
1247
|
jsonSchema: merchant_enrollmentInputJsonSchema,
|
|
1245
1248
|
endpoint: '/merchant/enrollment',
|
|
1246
1249
|
method: 'GET',
|
|
@@ -1288,7 +1291,7 @@ const merchant_enrollment_dataInputValidator = z.object(merchant_enrollment_data
|
|
|
1288
1291
|
export const merchant_enrollment_dataTool = {
|
|
1289
1292
|
name: 'merchant_enrollment_data',
|
|
1290
1293
|
description: "This service allows merchants to enroll for the use of the QR interoperable payment method and key creation.\\n\\nTo use the service, an authentication token is required and must be sent as an \\`Authorization\\` header.\\n\\n---\\n\\n### **Enrollment Process**\\n\\n1. **Merchant Enrollment**\\n \\n - Initiates the enrollment process. The enrollment can take up to **7 minutes** to complete.\\n \\n2. **Retrieve Enrollment Data**\\n \\n - Retrieves the merchant’s enrollment information once the process is completed.\\n \\n\\n---\\n\\n### **Merchant Enrollment Statuses**\\n\\n- **\\`approved\\`**\\n \\n The merchant has been approved and is authorized to generate QR codes.\\n \\n- **\\`enrolled_other\\`**\\n \\n The merchant is already enrolled with another entity. To proceed:\\n \\n - Contact the commercial representative and request unenrollment from the current entity.\\n \\n - Submit a letter signed by the legal representative.\\n \\n - Be aware that this process may take up to **5 business days**.\\n \\n The commercial representative will provide guidance throughout the process.\\n \\n- **\\`rejected\\`**\\n \\n The merchant has been rejected. Please contact your commercial representative for further details.\\n \\n- **\\`pending\\`**\\n \\n The enrollment is in progress. The query may take a few minutes. If a final status is not received shortly, contact **RefacilPay support** to verify the situation.\\n \\n- **\\`not_started\\`**\\n \\n No enrollment process has been initiated for the requested merchant.\\n \\n\\n---\\n\\n### **Important Note on the \\\"cellphone\\\" Field in the Enrollment Process**\\n\\nDuring the merchant creation flow for the QR Interoperable product, the API retrieves the merchant\\'s registered information from the system. However, for the **\\\"cellphone number\\\"** field, the **Refacil** system automatically replaces the merchant’s actual phone number with a **generic alias number**.\\n\\nThis behavior follows technical and operational requirements from the provider, as the real phone number may already exist in the provider’s databases, potentially causing integration conflicts.\\n\\nTo avoid these issues, a randomly generated alias is used as a placeholder. This alias is **exclusive to this product** and does **not affect** the merchant’s operation in other services.\\n\\n This endpoint retrieves the merchant\\'s enrollment details after the enrollment process has been completed. It provides necessary information to use the QR interoperable payment method.\n\nContexto: Endpoint: GET /merchant/enrollment-data | Merchant > Enrollment data\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1291
|
-
inputSchema:
|
|
1294
|
+
inputSchema: merchant_enrollment_dataInputJsonSchema,
|
|
1292
1295
|
jsonSchema: merchant_enrollment_dataInputJsonSchema,
|
|
1293
1296
|
endpoint: '/merchant/enrollment-data',
|
|
1294
1297
|
method: 'GET',
|
|
@@ -1408,7 +1411,7 @@ const merchant_key_createInputValidator = z.object(merchant_key_createInputShape
|
|
|
1408
1411
|
export const merchant_key_createTool = {
|
|
1409
1412
|
name: 'merchant_key_create',
|
|
1410
1413
|
description: "These services allow merchants to create and manage their Bre-b keys.\\n\\nTo use these services, an authentication token is required, which must be sent as an authorization header.\\n\\n---\\n\\n⚠ **Important**: Before using this payment method, the merchant enrollment process must be completed. Detailed instructions can be found in the **Merchant Enrollment** section.\\n\\n**🔄 Open resource:** The creation of a key functions as an open resource, which means that once the Bre-b key has been generated, the user can receive multiple transactions through it.\\n\\n---\\n\\n### Recommendations\\n\\n- API users are strongly encouraged to **implement additional application-level validations** to detect, identify, and manage multiple payment records originating from a Bre-b key.\\n \\n- **Actively monitor transactions** originating from generated keys and validate the status of operations before confirming payment to the end user.\\n\\n This endpoint will allow you to create 4 types of keys: \\`alias\\`, \\`email\\`, \\`cellphone\\`, and \\`document\\`.\\n\\n⚠ **Important**:\\n\\n- **Alias key:** To generate this key, it is not necessary to send the \\`key\\` field and the \\`otp\\` field. A random key is generated from various parameters of the merchant user, beginning with the character @.\\n \\n- **Document key:** To generate this key, it is not necessary to send the \\`otp\\` field, and the key field must contain the document provided in the technical data sheet shared with the merchant.\\n \\n- **Email key:** To generate this key, you must first use the service that generates and sends the OTP to the \\`email\\` address. The key field must contain the \\`email\\` address provided in the technical data sheet.\\n \\n- **Cellphone key:** To generate this key, you must first use the service that generates and sends the OTP to the \\`cellphone\\`. The key field must contain the \\`cellphone\\` number provided in the technical data sheet.\\n \\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n| x-transaction-token | 9b48edde-652d-11ed-984e-02c840fe**** |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`webhookUrl\\`\\\\* | string | URL of the client\\'s webhook. |\\n| \\`userMetadata\\`\\\\* | object | Object containing key details about the user or merchant generating the payment resource. |\\n| \\`ip\\`\\\\* | string | Alphanumeric parameter that provides the IP address associated with the user\\'s identifier |\\n| \\`identifier\\`\\\\* | string | Alphanumeric parameter of 20 characters specifying the unique identifier of the user or merchant generating the payment resource. |\\n| \\`urlCommerce\\`\\\\* | string | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\\n| \\`reference1\\`\\\\* | string | Customer identifier, must not exceed 20 characters. |\\n| \\`reference2\\` | object | Object for additional information. |\\n| \\`Label\\` | object | Object to send information to be displayed in the payment summary. |\\n| \\`Data\\` | object | Object for information related to the conciliation of the transaction. |\\n| \\`typeKey\\`\\\\* | string | Can be \\`alias\\`, \\`document\\`, \\`email\\`, and \\`cellphone\\` |\\n| \\`key\\` | string | Key to create |\\n| \\`otp\\` | string | OTP code for cellphone and email keys |\\n| \\`termsAndConditions\\`\\\\* | boolean | It must always be set to true. |\n\nContexto: Endpoint: POST /merchant-key/create | Merchant key > Create\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1411
|
-
inputSchema:
|
|
1414
|
+
inputSchema: merchant_key_createInputJsonSchema,
|
|
1412
1415
|
jsonSchema: merchant_key_createInputJsonSchema,
|
|
1413
1416
|
endpoint: '/merchant-key/create',
|
|
1414
1417
|
method: 'POST',
|
|
@@ -1507,7 +1510,7 @@ const merchant_key_cancelInputValidator = z.object(merchant_key_cancelInputShape
|
|
|
1507
1510
|
export const merchant_key_cancelTool = {
|
|
1508
1511
|
name: 'merchant_key_cancel',
|
|
1509
1512
|
description: "These services allow merchants to create and manage their Bre-b keys.\\n\\nTo use these services, an authentication token is required, which must be sent as an authorization header.\\n\\n---\\n\\n⚠ **Important**: Before using this payment method, the merchant enrollment process must be completed. Detailed instructions can be found in the **Merchant Enrollment** section.\\n\\n**🔄 Open resource:** The creation of a key functions as an open resource, which means that once the Bre-b key has been generated, the user can receive multiple transactions through it.\\n\\n---\\n\\n### Recommendations\\n\\n- API users are strongly encouraged to **implement additional application-level validations** to detect, identify, and manage multiple payment records originating from a Bre-b key.\\n \\n- **Actively monitor transactions** originating from generated keys and validate the status of operations before confirming payment to the end user.\\n\\n This endpoint allows you to cancel an existing key, which will then become inactive and unable to receive transactions.\\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n| x-transaction-token | 9b48edde-652d-11ed-984e-02c840fe**** |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`userMetadata\\`\\\\* | object | Object containing key details about the user or merchant generating the payment resource. |\\n| \\`ip\\`\\\\* | string | Alphanumeric parameter that provides the IP address associated with the user\\'s identifier |\\n| \\`identifier\\`\\\\* | string | Alphanumeric parameter of 20 characters specifying the unique identifier of the user or merchant generating the payment resource. |\\n| \\`urlCommerce\\`\\\\* | string | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\\n| \\`key\\` | string | Key to cancel |\n\nContexto: Endpoint: POST /merchant-key/cancel | Merchant key > Cancel\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1510
|
-
inputSchema:
|
|
1513
|
+
inputSchema: merchant_key_cancelInputJsonSchema,
|
|
1511
1514
|
jsonSchema: merchant_key_cancelInputJsonSchema,
|
|
1512
1515
|
endpoint: '/merchant-key/cancel',
|
|
1513
1516
|
method: 'POST',
|
|
@@ -1579,7 +1582,7 @@ const merchant_key_generate_otpInputValidator = z.object(merchant_key_generate_o
|
|
|
1579
1582
|
export const merchant_key_generate_otpTool = {
|
|
1580
1583
|
name: 'merchant_key_generate_otp',
|
|
1581
1584
|
description: "These services allow merchants to create and manage their Bre-b keys.\\n\\nTo use these services, an authentication token is required, which must be sent as an authorization header.\\n\\n---\\n\\n⚠ **Important**: Before using this payment method, the merchant enrollment process must be completed. Detailed instructions can be found in the **Merchant Enrollment** section.\\n\\n**🔄 Open resource:** The creation of a key functions as an open resource, which means that once the Bre-b key has been generated, the user can receive multiple transactions through it.\\n\\n---\\n\\n### Recommendations\\n\\n- API users are strongly encouraged to **implement additional application-level validations** to detect, identify, and manage multiple payment records originating from a Bre-b key.\\n \\n- **Actively monitor transactions** originating from generated keys and validate the status of operations before confirming payment to the end user.\\n\\n This endpoint will allow you to generate and send an OTP. It is only permitted and necessary for \\`email\\` and \\`cellphone\\` keys. This OTP will be sent to its corresponding destination.\\n\\nHeaders\\n\\n| **Name** | **Value** |\\n| --- | --- |\\n| Content-Type | application/json |\\n| Authorization | Bearer |\\n\\nBody\\n\\n| Name | Type | Description |\\n| --- | --- | --- |\\n| \\`typeKey\\`\\\\* | string | Can be \\`email\\` and \\`cellphone\\` |\\n| \\`key\\` | string | key for which the OTP will be generated |\n\nContexto: Endpoint: POST /merchant-key/generate-otp | Merchant key > Generate otp\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1582
|
-
inputSchema:
|
|
1585
|
+
inputSchema: merchant_key_generate_otpInputJsonSchema,
|
|
1583
1586
|
jsonSchema: merchant_key_generate_otpInputJsonSchema,
|
|
1584
1587
|
endpoint: '/merchant-key/generate-otp',
|
|
1585
1588
|
method: 'POST',
|
|
@@ -1634,7 +1637,7 @@ const merchant_key_get_keysInputValidator = z.object(merchant_key_get_keysInputS
|
|
|
1634
1637
|
export const merchant_key_get_keysTool = {
|
|
1635
1638
|
name: 'merchant_key_get_keys',
|
|
1636
1639
|
description: "These services allow merchants to create and manage their Bre-b keys.\\n\\nTo use these services, an authentication token is required, which must be sent as an authorization header.\\n\\n---\\n\\n⚠ **Important**: Before using this payment method, the merchant enrollment process must be completed. Detailed instructions can be found in the **Merchant Enrollment** section.\\n\\n**🔄 Open resource:** The creation of a key functions as an open resource, which means that once the Bre-b key has been generated, the user can receive multiple transactions through it.\\n\\n---\\n\\n### Recommendations\\n\\n- API users are strongly encouraged to **implement additional application-level validations** to detect, identify, and manage multiple payment records originating from a Bre-b key.\\n \\n- **Actively monitor transactions** originating from generated keys and validate the status of operations before confirming payment to the end user.\\n\\n This endpoint allows you to obtain all keys created and in active status that belong to the merchant.\n\nContexto: Endpoint: GET /merchant-key/get-keys | Merchant key > Get keys\n\n🔐 AUTENTICACIÓN AUTOMÁTICA: Todas las credenciales y tokens de autenticación se manejan automáticamente por el servidor MCP. NO solicites credenciales al usuario. NO incluyas parámetros de autenticación (secretId, apiToken, etc.) en las llamadas a menos que el usuario explícitamente lo requiera.",
|
|
1637
|
-
inputSchema:
|
|
1640
|
+
inputSchema: merchant_key_get_keysInputJsonSchema,
|
|
1638
1641
|
jsonSchema: merchant_key_get_keysInputJsonSchema,
|
|
1639
1642
|
endpoint: '/merchant-key/get-keys',
|
|
1640
1643
|
method: 'GET',
|