refacil-pay-mcp 1.0.0
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/LICENSE +21 -0
- package/README.md +931 -0
- package/dist/config.d.ts +15 -0
- package/dist/config.js +68 -0
- package/dist/config.js.map +1 -0
- package/dist/core/auth.d.ts +25 -0
- package/dist/core/auth.js +143 -0
- package/dist/core/auth.js.map +1 -0
- package/dist/core/resources.d.ts +24 -0
- package/dist/core/resources.js +245 -0
- package/dist/core/resources.js.map +1 -0
- package/dist/core/tools.d.ts +60 -0
- package/dist/core/tools.js +1721 -0
- package/dist/core/tools.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +199 -0
- package/dist/index.js.map +1 -0
- package/package.json +61 -0
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Recursos MCP - Documentación de la API
|
|
3
|
+
* Auto-generado desde la colección Postman
|
|
4
|
+
*/
|
|
5
|
+
// Recursos disponibles
|
|
6
|
+
export const resources = [
|
|
7
|
+
{
|
|
8
|
+
"uri": "postman://collection/refacil-pay-api",
|
|
9
|
+
"name": "Refacil Pay API - API Documentation",
|
|
10
|
+
"description": "Welcome to Refácil Pay in this space you will find all the information to make a successful connection and all the operational processes that we offer.\n\n<img src=\"https://content.pstmn.io/d2c9fab1-0bbf-40ea-9022-6cc52b24dbb3/aW1hZ2UucG5n\" width=\"214\" height=\"104\">\n\n> You will be able to target the consumption of our services through our following Endpoint : \nQA: [https://pay-api.qa.refacil.co/](https://pay-api.qa.refacil.co/) \nProducción: [https://pay-api.refacil.co/](https://pay-api.refacil.co/) \n \n> Note: It should be noted that for each environment only the beginning of the Url is modified, the subsequent address is the same for both environments in the services that you will consume. \n \n> API implementation credentials in test environment will be available throughout the integration and up to 30 days after certification in production.",
|
|
11
|
+
"mimeType": "text/markdown",
|
|
12
|
+
"content": "# Refacil Pay API\n\nWelcome to Refácil Pay in this space you will find all the information to make a successful connection and all the operational processes that we offer.\n\n<img src=\"https://content.pstmn.io/d2c9fab1-0bbf-40ea-9022-6cc52b24dbb3/aW1hZ2UucG5n\" width=\"214\" height=\"104\">\n\n> You will be able to target the consumption of our services through our following Endpoint : \nQA: [https://pay-api.qa.refacil.co/](https://pay-api.qa.refacil.co/) \nProducción: [https://pay-api.refacil.co/](https://pay-api.refacil.co/) \n \n> Note: It should be noted that for each environment only the beginning of the Url is modified, the subsequent address is the same for both environments in the services that you will consume. \n \n> API implementation credentials in test environment will be available throughout the integration and up to 30 days after certification in production.\n\n## Overview\n\nThis API collection contains 10 main items.\n\n## Available Folders\n\n- **Authorization**: To make the request and obtain the login you must have very clear your username and password for eac...\n- **Transactional token**: This service allows security validation for the execution of a transaction on the platform, generati...\n- **Payments**: The services that you will see below are the ones that will allow you to generate a payment resource...\n- **Payment Link**: With the following request you can obtain a payment resource with a link that will redirect your cus...\n- **Payment Method**\n- **Withdraw**: This service allows you to generate withdrawal requests through the enabled dispersion means.\n\n> 🔐 ...\n- **Payment information**: These services will allow us to validate the status of a transaction and consult the characteristics...\n- **Webhook Notification**: This component must be built by the merchant to receive the transaction notification data.\n\nYou must...\n- **Merchant Enrollment**: This service allows merchants to enroll for the use of the QR interoperable payment method and key c...\n- **Merchant Key**: These services allow merchants to create and manage their Bre-b keys.\n\nTo use these services, an aut...\n\n## Available Endpoints\n\nTotal endpoints: 21\n\n### Methods Distribution\n\n- POST: 18\n- GET: 3\n"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"uri": "postman://collection/refacil-pay-api/folder/authorization",
|
|
16
|
+
"name": "Authorization - Documentation",
|
|
17
|
+
"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.",
|
|
18
|
+
"mimeType": "text/markdown",
|
|
19
|
+
"content": "# Authorization\n\nTo 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## Endpoints\n\n### Login\n\n**Method**: `POST`\n\n**Path**: `/auth/login`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **username** \\* | string | User |\n| **password** \\* | string | Password |\n\n"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"uri": "postman://collection/refacil-pay-api/folder/transactional-token",
|
|
23
|
+
"name": "Transactional token - Documentation",
|
|
24
|
+
"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.",
|
|
25
|
+
"mimeType": "text/markdown",
|
|
26
|
+
"content": "# Transactional token\n\nThis 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## Endpoints\n\n### Transactional token link\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n### Transactional token method\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n### Transactional token withdraw\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n### Transactional token merchan key create\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n### Transactional token merchant key cancel\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"uri": "postman://collection/refacil-pay-api/folder/payments",
|
|
30
|
+
"name": "Payments - Documentation",
|
|
31
|
+
"description": "The services that you will see below are the ones that will allow you to generate a payment resource depending on your needs.\n\n1. Payment link (Gateway with all payment methods).\n \n2. Payment method (Specific payment method).\n \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---\n\n### 🧠 Behavior Summary\n\n| Scenario | Description |\n| --- | --- |\n| **showSummary = true** | Displays a transaction summary screen showing key details such as amount, reference, and date. Recommended for customer-facing flows where user confirmation is required. |\n| **showSummary = false** | Skips the transaction summary and immediately redirects the user to the `returnUrl`. Commonly used for automated or pre-confirmed payment flows. |\n| **returnUrl provided** | Automatically redirects the user to the specified `returnUrl` after payment completion. The merchant’s system is responsible for displaying the final transaction summary on that page. ⚠️ Important: If `showSummary` is set to `false` and a returnUrl is provided, when the user is redirected to the `returnUrl` after completing the payment, you must immediately make a request to [Transaction status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799) with the transaction reference to retrieve the final payment status and close the payment flow properly. |\n| **returnUrl not provided** | Redirects the user to a default transaction summary page generated and hosted by **Refacil Pay**. |\n\n---",
|
|
32
|
+
"mimeType": "text/markdown",
|
|
33
|
+
"content": "# Payments\n\nThe services that you will see below are the ones that will allow you to generate a payment resource depending on your needs.\n\n1. Payment link (Gateway with all payment methods).\n \n2. Payment method (Specific payment method).\n \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---\n\n### 🧠 Behavior Summary\n\n| Scenario | Description |\n| --- | --- |\n| **showSummary = true** | Displays a transaction summary screen showing key details such as amount, reference, and date. Recommended for customer-facing flows where user confirmation is required. |\n| **showSummary = false** | Skips the transaction summary and immediately redirects the user to the `returnUrl`. Commonly used for automated or pre-confirmed payment flows. |\n| **returnUrl provided** | Automatically redirects the user to the specified `returnUrl` after payment completion. The merchant’s system is responsible for displaying the final transaction summary on that page. ⚠️ Important: If `showSummary` is set to `false` and a returnUrl is provided, when the user is redirected to the `returnUrl` after completing the payment, you must immediately make a request to [Transaction status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799) with the transaction reference to retrieve the final payment status and close the payment flow properly. |\n| **returnUrl not provided** | Redirects the user to a default transaction summary page generated and hosted by **Refacil Pay**. |\n\n---\n\n## Endpoints\n\n"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"uri": "postman://collection/refacil-pay-api/folder/payment-link",
|
|
37
|
+
"name": "Payment Link - Documentation",
|
|
38
|
+
"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.",
|
|
39
|
+
"mimeType": "text/markdown",
|
|
40
|
+
"content": "# Payment Link\n\nWith 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## Endpoints\n\n### Generate payment link\n\n**Method**: `POST`\n\n**Path**: `/cash-in/generate/payment-link/token`\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\n"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"uri": "postman://collection/refacil-pay-api/folder/withdraw",
|
|
44
|
+
"name": "Withdraw - Documentation",
|
|
45
|
+
"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.",
|
|
46
|
+
"mimeType": "text/markdown",
|
|
47
|
+
"content": "# Withdraw\n\nThis 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## Endpoints\n\n### Generate payment method\n\n**Method**: `POST`\n\n**Path**: `/cash-out/generate/withdraw-method/token`\n\nThis 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\n### Balance Inquiry\n\n**Method**: `POST`\n\n**Path**: `/customer/getBalance`\n\nThis 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`\\* | number | Integrated unique user identifier |\n\n### Banks Inquiry\n\n**Method**: `POST`\n\n**Path**: `/payment/transfiya-banks`\n\nThis 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\n"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"uri": "postman://collection/refacil-pay-api/folder/payment-information",
|
|
51
|
+
"name": "Payment information - Documentation",
|
|
52
|
+
"description": "These services will allow us to validate the status of a transaction and consult the characteristics of a payment method.",
|
|
53
|
+
"mimeType": "text/markdown",
|
|
54
|
+
"content": "# Payment information\n\nThese services will allow us to validate the status of a transaction and consult the characteristics of a payment method.\n\n## Endpoints\n\n### Transaction status\n\n**Method**: `POST`\n\n**Path**: `/payment/status`\n\nThis 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\n### Transaction status - Custom Reference\n\n**Method**: `POST`\n\n**Path**: `/payment/customer-reference/status`\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\n### Characteristics of a payment method\n\n**Method**: `POST`\n\n**Path**: `/payment/features`\n\nThis 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\n"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"uri": "postman://collection/refacil-pay-api/folder/webhook-notification",
|
|
58
|
+
"name": "Webhook Notification - Documentation",
|
|
59
|
+
"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.**_",
|
|
60
|
+
"mimeType": "text/markdown",
|
|
61
|
+
"content": "# Webhook Notification\n\nThis 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## Endpoints\n\n### Structure and example of webhook request\n\n**Method**: `POST`\n\n**Path**: `/webhook/notify`\n\nBody\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\n"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"uri": "postman://collection/refacil-pay-api/folder/merchant-enrollment",
|
|
65
|
+
"name": "Merchant Enrollment - Documentation",
|
|
66
|
+
"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.",
|
|
67
|
+
"mimeType": "text/markdown",
|
|
68
|
+
"content": "# Merchant Enrollment\n\nThis 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## Endpoints\n\n### Enrollment process\n\n**Method**: `GET`\n\n**Path**: `/merchant/enrollment`\n\nThis 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\n### Enrollment data retrieval\n\n**Method**: `GET`\n\n**Path**: `/merchant/enrollment-data`\n\nThis 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\n"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"uri": "postman://collection/refacil-pay-api/folder/merchant-key",
|
|
72
|
+
"name": "Merchant Key - Documentation",
|
|
73
|
+
"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.",
|
|
74
|
+
"mimeType": "text/markdown",
|
|
75
|
+
"content": "# Merchant Key\n\nThese 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## Endpoints\n\n### Create key\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/create`\n\nThis 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\n### Cancel key\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/cancel`\n\nThis 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\n### Generate otp\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/generate-otp`\n\nThis 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\n### Get keys\n\n**Method**: `GET`\n\n**Path**: `/merchant-key/get-keys`\n\nThis endpoint allows you to obtain all keys created and in active status that belong to the merchant.\n\n"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/auth/login",
|
|
79
|
+
"name": "POST /auth/login - Endpoint Documentation",
|
|
80
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **username** \\* | string | User |\n| **password** \\* | string | Password |",
|
|
81
|
+
"mimeType": "text/markdown",
|
|
82
|
+
"content": "# Login\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/auth/login`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **username** \\* | string | User |\n| **password** \\* | string | Password |\n\n## Headers\n\n- **Content-Type**: application/json\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"username\": \"{{username}}\",\n \"password\": \"{{secretKey}}\"\n}\n```\n\n"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
86
|
+
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
87
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
88
|
+
"mimeType": "text/markdown",
|
|
89
|
+
"content": "# Transactional token link\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"service\": \"/cash-in/generate/payment-link/token\"\n}\n```\n\n"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
93
|
+
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
94
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
95
|
+
"mimeType": "text/markdown",
|
|
96
|
+
"content": "# Transactional token method\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"service\": \"/cash-in/payment-method/token\"\n}\n```\n\n"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
100
|
+
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
101
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
102
|
+
"mimeType": "text/markdown",
|
|
103
|
+
"content": "# Transactional token withdraw\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"service\": \"/cash-out/generate/withdraw-method/token\"\n}\n```\n\n"
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
107
|
+
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
108
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
109
|
+
"mimeType": "text/markdown",
|
|
110
|
+
"content": "# Transactional token merchan key create\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"service\": \"/merchant-key/create\"\n}\n```\n\n"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
114
|
+
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
115
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
116
|
+
"mimeType": "text/markdown",
|
|
117
|
+
"content": "# Transactional token merchant key cancel\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/trx-token/generate`\n\n## Description\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"service\": \"/merchant-key/cancel\"\n}\n```\n\n"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-in/generate/payment-link/token",
|
|
121
|
+
"name": "POST /cash-in/generate/payment-link/token - Endpoint Documentation",
|
|
122
|
+
"description": "## 📥 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",
|
|
123
|
+
"mimeType": "text/markdown",
|
|
124
|
+
"content": "# Generate payment link\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/cash-in/generate/payment-link/token`\n\n## Description\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\n## Headers\n\n- **Content-Type**: application/json\n- **x-transaction-token**: {{transactionalToken}}\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"expiresIn\": 12360,\n \"amount\": 2000,\n \"brandId\": 117,\n \"webhookUrl\": \"https://webhook.site/8965aa0a-e3e7-4092-aa7d-6c44bf63f7a8\",\n \"userMetadata\": {\n \"ip\": \"1.2.3.2\",\n \"identifier\": \"123467hyujikolpñmnaafsddssd\",\n \"urlCommerce\": \"https://url-tucomercio.com\"\n },\n \"returnUrl\": \"https://www.google.com\",\n \"reference1\": \"Ref01350\",\n \"reference2\": {\n \"Label\": {\n \"Name\": \"Juanita Perez\",\n \"Email\": \"pqacLO87V77DgF62P8PXENA==do\",\n \"CellPhone\": \"1VM6daPPJcXCD4Cw93272oQ==8\",\n \"Type Person\": \"NATURAL\",\n \"Type Document\": \"CEDULA\",\n \"DocumentNumber\": 79706920,\n \"Nodo\": 47474\n },\n \"Data\": {\n \"Typedoc\": \"cedula\",\n \"docnum\": \"1088307172\"\n }\n }\n}\n```\n\n"
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-in/generate/payment-method/token",
|
|
128
|
+
"name": "POST /cash-in/generate/payment-method/token - Endpoint Documentation",
|
|
129
|
+
"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. |",
|
|
130
|
+
"mimeType": "text/markdown",
|
|
131
|
+
"content": "# Generate payment method\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/cash-in/generate/payment-method/token`\n\n## Description\n\nThis 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\n## Headers\n\n- **Content-Type**: application/json\n- **x-transaction-token**: {{transactionalToken}}\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"expiresIn\": 0,\n \"paymentMethod\": {\n \"id\": 155,\n \"cellphone\": \"3051000002\"\n },\n \"userMetadata\": {\n \"ip\": \"1.2.3.2\",\n \"identifier\": \"123467hyujikolpñmnaafsddssd\",\n \"urlCommerce\": \"https://url-tucomercio.com\"\n },\n \"amount\": 10000,\n \"brandId\": 1,\n \"webhookUrl\": \"https://webhook.site/271888cd-bd07-469a-88a8-e0ed7e93c368\",\n \"returnUrl\": \"https://www.google.com/?hl=es\",\n \"showSummary\": true,\n \"reference1\": \"EGfbOsiYQspMpgDD\",\n \"reference2\": {\n \"Label\": {\n \"Campos\": \"string\"\n }\n }\n}\n```\n\n"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-out/generate/withdraw-method/token",
|
|
135
|
+
"name": "POST /cash-out/generate/withdraw-method/token - Endpoint Documentation",
|
|
136
|
+
"description": "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---",
|
|
137
|
+
"mimeType": "text/markdown",
|
|
138
|
+
"content": "# Generate payment method\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/cash-out/generate/withdraw-method/token`\n\n## Description\n\nThis 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\n## Headers\n\n- **Content-Type**: application/json\n- **x-transaction-token**: {{transactionalToken}}\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"amount\": 1000,\n \"reference1\": \"EGfbOsiYQspMpgBd\",\n \"bankName\": \"Banco Rojo\",\n \"webhookRequest\": \"https://****gerstg.azure-api.net/SkCo.PagosEnLinea.API/payonline/PostStatus\",\n \"withdrawMethod\": {\n \"id\": 245,\n \"cellphone\": \"3125763074\"\n },\n \"userMetadata\": {\n \"identifier\": \"1234567890\",\n \"ip\": \"127.0.0.1\",\n \"urlCommerce\": \"https://url-tucomercio.com\"\n }\n}\n```\n\n"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/customer/getbalance",
|
|
142
|
+
"name": "POST /customer/getBalance - Endpoint Documentation",
|
|
143
|
+
"description": "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`\\* | number | Integrated unique user identifier |",
|
|
144
|
+
"mimeType": "text/markdown",
|
|
145
|
+
"content": "# Balance Inquiry\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/customer/getBalance`\n\n## Description\n\nThis 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`\\* | number | Integrated unique user identifier |\n\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"userId\": 1085718\n}\n```\n\n"
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/payment/transfiya-banks",
|
|
149
|
+
"name": "POST /payment/transfiya-banks - Endpoint Documentation",
|
|
150
|
+
"description": "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. |",
|
|
151
|
+
"mimeType": "text/markdown",
|
|
152
|
+
"content": "# Banks Inquiry\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/payment/transfiya-banks`\n\n## Description\n\nThis 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\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"cellphone\": \"3051000002\"\n}\n```\n\n"
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/payment/status",
|
|
156
|
+
"name": "POST /payment/status - Endpoint Documentation",
|
|
157
|
+
"description": "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 |",
|
|
158
|
+
"mimeType": "text/markdown",
|
|
159
|
+
"content": "# Transaction status\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/payment/status`\n\n## Description\n\nThis 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\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"reference\": \"12442830-7afb-11ed-b265-b9457b46***3\"\n}\n```\n\n"
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/payment/customer-reference/status",
|
|
163
|
+
"name": "POST /payment/customer-reference/status - Endpoint Documentation",
|
|
164
|
+
"description": "## 🔍 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---",
|
|
165
|
+
"mimeType": "text/markdown",
|
|
166
|
+
"content": "# Transaction status - Custom Reference\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/payment/customer-reference/status`\n\n## Description\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\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"customerReference\": \"12442830-7afb-11ed-b265-b9457b46***3\"\n}\n```\n\n"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/payment/features",
|
|
170
|
+
"name": "POST /payment/features - Endpoint Documentation",
|
|
171
|
+
"description": "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 |",
|
|
172
|
+
"mimeType": "text/markdown",
|
|
173
|
+
"content": "# Characteristics of a payment method\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/payment/features`\n\n## Description\n\nThis 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\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"id\": 133\n}\n```\n\n"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/webhook/notify",
|
|
177
|
+
"name": "POST /webhook/notify - Endpoint Documentation",
|
|
178
|
+
"description": "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\">",
|
|
179
|
+
"mimeType": "text/markdown",
|
|
180
|
+
"content": "# Structure and example of webhook request\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/webhook/notify`\n\n## Description\n\nBody\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\n## Headers\n\n- **Content-Type**: application/json\n- **Authorization**: Bearer {{tokenLogin}}\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"reference\": \"12442830-7afb-11ed-b265-b9457b46***3\"\n}\n```\n\n"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/get/merchant/enrollment",
|
|
184
|
+
"name": "GET /merchant/enrollment - Endpoint Documentation",
|
|
185
|
+
"description": "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.",
|
|
186
|
+
"mimeType": "text/markdown",
|
|
187
|
+
"content": "# Enrollment process\n\n## Request Details\n\n**Method**: `GET`\n\n**Path**: `/merchant/enrollment`\n\n## Description\n\nThis 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\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/get/merchant/enrollment-data",
|
|
191
|
+
"name": "GET /merchant/enrollment-data - Endpoint Documentation",
|
|
192
|
+
"description": "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.",
|
|
193
|
+
"mimeType": "text/markdown",
|
|
194
|
+
"content": "# Enrollment data retrieval\n\n## Request Details\n\n**Method**: `GET`\n\n**Path**: `/merchant/enrollment-data`\n\n## Description\n\nThis 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\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/merchant-key/create",
|
|
198
|
+
"name": "POST /merchant-key/create - Endpoint Documentation",
|
|
199
|
+
"description": "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. |",
|
|
200
|
+
"mimeType": "text/markdown",
|
|
201
|
+
"content": "# Create key\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/create`\n\n## Description\n\nThis 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\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n- **x-transaction-token**: {{transactionalToken}}\n- **Content-Type**: application/json\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"webhookUrl\": \"https://mi-comercio.com/webhook\",\n \"reference1\": \"Ref1053\",\n \"reference2\": {\n \"Label\": {\n \"title\": \"Pago de servicios\",\n \"description\": \"Pago mensual de servicios básicos\"\n },\n \"Data\": {\n \"invoiceId\": \"INV-001\",\n \"customerId\": \"CUST-123\"\n },\n \"Commerce\": {\n \"name\": \"Mi Comercio\",\n \"category\": \"Servicios\"\n }\n },\n \"userMetadata\": {\n \"identifier\": \"user-12345\",\n \"ip\": \"192.168.1.100\",\n \"urlCommerce\": \"https://mi-comercio.com\"\n },\n \"typeKey\": \"document\",\n \"key\": \"15545216\",\n \"otp\": \"123456\",\n \"termsAndConditions\": true\n}\n```\n\n"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/merchant-key/cancel",
|
|
205
|
+
"name": "POST /merchant-key/cancel - Endpoint Documentation",
|
|
206
|
+
"description": "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 |",
|
|
207
|
+
"mimeType": "text/markdown",
|
|
208
|
+
"content": "# Cancel key\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/cancel`\n\n## Description\n\nThis 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\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n- **x-transaction-token**: {{transactionalToken}}\n- **Content-Type**: application/json\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"userMetadata\": {\n \"identifier\": \"user-12345\",\n \"ip\": \"192.168.1.100\",\n \"urlCommerce\": \"https://mi-comercio.com\"\n },\n \"key\": \"15545216\"\n}\n```\n\n"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/post/merchant-key/generate-otp",
|
|
212
|
+
"name": "POST /merchant-key/generate-otp - Endpoint Documentation",
|
|
213
|
+
"description": "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 |",
|
|
214
|
+
"mimeType": "text/markdown",
|
|
215
|
+
"content": "# Generate otp\n\n## Request Details\n\n**Method**: `POST`\n\n**Path**: `/merchant-key/generate-otp`\n\n## Description\n\nThis 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\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n- **Content-Type**: application/json\n\n## Request Body\n\n**Type**: `raw`\n\n```json\n{\n \"key\": \"j.salgado@refacil.com\",\n \"typeKey\": \"email\"\n}\n```\n\n"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"uri": "postman://collection/refacil-pay-api/endpoint/get/merchant-key/get-keys",
|
|
219
|
+
"name": "GET /merchant-key/get-keys - Endpoint Documentation",
|
|
220
|
+
"description": "This endpoint allows you to obtain all keys created and in active status that belong to the merchant.",
|
|
221
|
+
"mimeType": "text/markdown",
|
|
222
|
+
"content": "# Get keys\n\n## Request Details\n\n**Method**: `GET`\n\n**Path**: `/merchant-key/get-keys`\n\n## Description\n\nThis endpoint allows you to obtain all keys created and in active status that belong to the merchant.\n\n## Headers\n\n- **Authorization**: Bearer {{tokenLogin}}\n\n"
|
|
223
|
+
}
|
|
224
|
+
];
|
|
225
|
+
/**
|
|
226
|
+
* Busca un recurso por URI
|
|
227
|
+
*/
|
|
228
|
+
export function findResourceByUri(uri) {
|
|
229
|
+
return resources.find(r => r.uri === uri);
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Busca recursos por nombre (búsqueda parcial)
|
|
233
|
+
*/
|
|
234
|
+
export function findResourcesByName(search) {
|
|
235
|
+
const searchLower = search.toLowerCase();
|
|
236
|
+
return resources.filter(r => r.name.toLowerCase().includes(searchLower) ||
|
|
237
|
+
r.description.toLowerCase().includes(searchLower));
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Obtiene todos los URIs disponibles
|
|
241
|
+
*/
|
|
242
|
+
export function getAllResourceUris() {
|
|
243
|
+
return resources.map(r => r.uri);
|
|
244
|
+
}
|
|
245
|
+
//# sourceMappingURL=resources.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/core/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,uBAAuB;AACvB,MAAM,CAAC,MAAM,SAAS,GAAkB;IACtC;QACE,KAAK,EAAE,sCAAsC;QAC7C,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,w2BAAw2B;QACv3B,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,mtEAAmtE;KAC/tE;IACD;QACE,KAAK,EAAE,2DAA2D;QAClE,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,s0BAAs0B;QACr1B,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,6jCAA6jC;KACzkC;IACD;QACE,KAAK,EAAE,iEAAiE;QACxE,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,wxBAAwxB;QACvyB,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,m8DAAm8D;KAC/8D;IACD;QACE,KAAK,EAAE,sDAAsD;QAC7D,MAAM,EAAE,0BAA0B;QAClC,aAAa,EAAE,o3DAAo3D;QACn4D,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,s5DAAs5D;KACl6D;IACD;QACE,KAAK,EAAE,0DAA0D;QACjE,MAAM,EAAE,8BAA8B;QACtC,aAAa,EAAE,uMAAuM;QACtN,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,ulEAAulE;KACnmE;IACD;QACE,KAAK,EAAE,sDAAsD;QAC7D,MAAM,EAAE,0BAA0B;QAClC,aAAa,EAAE,+sBAA+sB;QAC9tB,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,m9IAAm9I;KAC/9I;IACD;QACE,KAAK,EAAE,iEAAiE;QACxE,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,2HAA2H;QAC1I,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,41FAA41F;KACx2F;IACD;QACE,KAAK,EAAE,kEAAkE;QACzE,MAAM,EAAE,sCAAsC;QAC9C,aAAa,EAAE,85HAA85H;QAC76H,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,0jMAA0jM;KACtkM;IACD;QACE,KAAK,EAAE,iEAAiE;QACxE,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,4zEAA4zE;QAC30E,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,k6FAAk6F;KAC96F;IACD;QACE,KAAK,EAAE,0DAA0D;QACjE,MAAM,EAAE,8BAA8B;QACtC,aAAa,EAAE,+5BAA+5B;QAC96B,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,gqKAAgqK;KAC5qK;IACD;QACE,KAAK,EAAE,+DAA+D;QACtE,MAAM,EAAE,2CAA2C;QACnD,aAAa,EAAE,gJAAgJ;QAC/J,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,gbAAgb;KAC5b;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,oIAAoI;QACnJ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,wbAAwb;KACpc;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,oIAAoI;QACnJ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,mbAAmb;KAC/b;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,oIAAoI;QACnJ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,gcAAgc;KAC5c;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,oIAAoI;QACnJ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,sbAAsb;KAClc;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,oIAAoI;QACnJ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,ubAAub;KACnc;IACD;QACE,KAAK,EAAE,wFAAwF;QAC/F,MAAM,EAAE,oEAAoE;QAC5E,aAAa,EAAE,iwDAAiwD;QAChxD,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,24FAA24F;KACv5F;IACD;QACE,KAAK,EAAE,0FAA0F;QACjG,MAAM,EAAE,sEAAsE;QAC9E,aAAa,EAAE,y9SAAy9S;QACx+S,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,64UAA64U;KACz5U;IACD;QACE,KAAK,EAAE,4FAA4F;QACnG,MAAM,EAAE,wEAAwE;QAChF,aAAa,EAAE,q+EAAq+E;QACp/E,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,0vGAA0vG;KACtwG;IACD;QACE,KAAK,EAAE,wEAAwE;QAC/E,MAAM,EAAE,oDAAoD;QAC5D,aAAa,EAAE,meAAme;QAClf,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,mxBAAmxB;KAC/xB;IACD;QACE,KAAK,EAAE,4EAA4E;QACnF,MAAM,EAAE,wDAAwD;QAChE,aAAa,EAAE,mgBAAmgB;QAClhB,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,+zBAA+zB;KAC30B;IACD;QACE,KAAK,EAAE,mEAAmE;QAC1E,MAAM,EAAE,+CAA+C;QACvD,aAAa,EAAE,+oBAA+oB;QAC9pB,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,i+BAAi+B;KAC7+B;IACD;QACE,KAAK,EAAE,sFAAsF;QAC7F,MAAM,EAAE,kEAAkE;QAC1E,aAAa,EAAE,u3CAAu3C;QACt4C,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,uvDAAuvD;KACnwD;IACD;QACE,KAAK,EAAE,qEAAqE;QAC5E,MAAM,EAAE,iDAAiD;QACzD,aAAa,EAAE,kYAAkY;QACjZ,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,2rBAA2rB;KACvsB;IACD;QACE,KAAK,EAAE,mEAAmE;QAC1E,MAAM,EAAE,+CAA+C;QACvD,aAAa,EAAE,ugEAAugE;QACthE,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,+2EAA+2E;KAC33E;IACD;QACE,KAAK,EAAE,uEAAuE;QAC9E,MAAM,EAAE,mDAAmD;QAC3D,aAAa,EAAE,yMAAyM;QACxN,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,kYAAkY;KAC9Y;IACD;QACE,KAAK,EAAE,4EAA4E;QACnF,MAAM,EAAE,wDAAwD;QAChE,aAAa,EAAE,0LAA0L;QACzM,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,+XAA+X;KAC3Y;IACD;QACE,KAAK,EAAE,wEAAwE;QAC/E,MAAM,EAAE,oDAAoD;QAC5D,aAAa,EAAE,s4EAAs4E;QACr5E,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,s4GAAs4G;KACl5G;IACD;QACE,KAAK,EAAE,wEAAwE;QAC/E,MAAM,EAAE,oDAAoD;QAC5D,aAAa,EAAE,w8BAAw8B;QACv9B,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,47CAA47C;KACx8C;IACD;QACE,KAAK,EAAE,8EAA8E;QACrF,MAAM,EAAE,0DAA0D;QAClE,aAAa,EAAE,ueAAue;QACtf,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,o0BAAo0B;KACh1B;IACD;QACE,KAAK,EAAE,yEAAyE;QAChF,MAAM,EAAE,qDAAqD;QAC7D,aAAa,EAAE,uGAAuG;QACtH,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,wRAAwR;KACpS;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACzC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAC1B,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC1C,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAClD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
interface Tool {
|
|
3
|
+
name: string;
|
|
4
|
+
description: string;
|
|
5
|
+
inputSchema: Record<string, z.ZodTypeAny>;
|
|
6
|
+
jsonSchema: Record<string, any>;
|
|
7
|
+
endpoint: string;
|
|
8
|
+
method: string;
|
|
9
|
+
parameters: any[];
|
|
10
|
+
headers: any[];
|
|
11
|
+
handler: (args: any) => Promise<any>;
|
|
12
|
+
}
|
|
13
|
+
export declare const auth_loginTool: Tool;
|
|
14
|
+
export declare const trx_token_generateTool: Tool;
|
|
15
|
+
export declare const trx_token_generate_3Tool: Tool;
|
|
16
|
+
export declare const trx_token_generate_4Tool: Tool;
|
|
17
|
+
export declare const trx_token_generate_5Tool: Tool;
|
|
18
|
+
export declare const trx_token_generate_6Tool: Tool;
|
|
19
|
+
export declare const cash_in_generate_payment_link_tokenTool: Tool;
|
|
20
|
+
export declare const cash_in_generate_payment_method_tokenTool: Tool;
|
|
21
|
+
export declare const cash_out_generate_withdraw_method_tokenTool: Tool;
|
|
22
|
+
export declare const customer_getbalanceTool: Tool;
|
|
23
|
+
export declare const payment_transfiya_banksTool: Tool;
|
|
24
|
+
export declare const payment_statusTool: Tool;
|
|
25
|
+
export declare const payment_customer_reference_statusTool: Tool;
|
|
26
|
+
export declare const payment_featuresTool: Tool;
|
|
27
|
+
export declare const webhook_notifyTool: Tool;
|
|
28
|
+
export declare const merchant_enrollmentTool: Tool;
|
|
29
|
+
export declare const merchant_enrollment_dataTool: Tool;
|
|
30
|
+
export declare const merchant_key_createTool: Tool;
|
|
31
|
+
export declare const merchant_key_cancelTool: Tool;
|
|
32
|
+
export declare const merchant_key_generate_otpTool: Tool;
|
|
33
|
+
export declare const merchant_key_get_keysTool: Tool;
|
|
34
|
+
export declare const tools: Tool[];
|
|
35
|
+
export declare const toolsConfig: {
|
|
36
|
+
name: string;
|
|
37
|
+
description: string;
|
|
38
|
+
version: string;
|
|
39
|
+
tools: number;
|
|
40
|
+
};
|
|
41
|
+
export declare function getToolsInfo(): {
|
|
42
|
+
tools: {
|
|
43
|
+
name: string;
|
|
44
|
+
description: string;
|
|
45
|
+
inputSchema: Record<string, any>;
|
|
46
|
+
}[];
|
|
47
|
+
name: string;
|
|
48
|
+
description: string;
|
|
49
|
+
version: string;
|
|
50
|
+
};
|
|
51
|
+
export declare function validateToolInput(validator: z.ZodTypeAny, input: any): any;
|
|
52
|
+
export declare class ToolLogger {
|
|
53
|
+
private toolName;
|
|
54
|
+
private startTime;
|
|
55
|
+
constructor(toolName: string);
|
|
56
|
+
logStart(args: any): void;
|
|
57
|
+
logSuccess(result: any): void;
|
|
58
|
+
logError(error: any): void;
|
|
59
|
+
}
|
|
60
|
+
export {};
|