refacil-commerce-mcp 1.0.10 → 1.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -375
- package/dist/core/resources.js +56 -49
- package/dist/core/resources.js.map +1 -1
- package/dist/core/tools.d.ts +5 -4
- package/dist/core/tools.js +143 -58
- package/dist/core/tools.js.map +1 -1
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ Servidor MCP (Model Context Protocol) generado automáticamente para la API refa
|
|
|
4
4
|
|
|
5
5
|
## 🚀 Características
|
|
6
6
|
|
|
7
|
-
- **
|
|
7
|
+
- **33 herramientas** generadas automáticamente desde la colección Postman
|
|
8
8
|
- **Autenticación flexible**: Username/SecretKey con renovación automática de tokens
|
|
9
9
|
- **Servidor HTTP** con Fastify
|
|
10
10
|
- **Protocolo MCP** estándar para integración con IDEs
|
|
@@ -214,6 +214,14 @@ To prevent abuse and repeated attempts in a short period, this endpoint applies
|
|
|
214
214
|
|
|
215
215
|
If these limits are exceeded, the API will temporarily reject additional calls, effectively asking the client to **wait a moment before trying again**.
|
|
216
216
|
|
|
217
|
+
### Token expiration
|
|
218
|
+
|
|
219
|
+
The access token **expires after 2 hours of inactivity**—that is, after **2 consecutive hours** with **no** authenticated API request using that token. **Expiry is based on idle time, not on how long ago the token was issued.** Successful requests that send the token typically **reset the inactivity window**; integrations that may remain idle longer than **2 hours** should plan to log in again or treat auth errors as described in **Integration guidance**.
|
|
220
|
+
|
|
221
|
+
### Integration guidance
|
|
222
|
+
|
|
223
|
+
When a protected request fails because the token is **invalid or expired** (including after an idle timeout), the API may respond with **401 Unauthorized** or **403 Forbidden** (or another documented authentication error for this API). **Call this login again** to obtain a **new** token, update the `Authorization` header, and **retry the original request once**. Use a clear policy to avoid infinite loops: one login plus one retry per failed call is the standard pattern; if authentication still fails, stop retrying and investigate credentials, user blocking, or rate limits.
|
|
224
|
+
|
|
217
225
|
---
|
|
218
226
|
|
|
219
227
|
### Request Body
|
|
@@ -222,8 +230,6 @@ If these limits are exceeded, the API will temporarily reject additional calls,
|
|
|
222
230
|
|
|
223
231
|
- `secretKey` (string) `required` - Secret key for authentication
|
|
224
232
|
|
|
225
|
-
- `saveSession` (boolean) - Flag that, if sent as `false`, allows the generated token to have an expiration of 12 hours.
|
|
226
|
-
|
|
227
233
|
|
|
228
234
|
---
|
|
229
235
|
|
|
@@ -237,7 +243,7 @@ If these limits are exceeded, the API will temporarily reject additional calls,
|
|
|
237
243
|
|
|
238
244
|
- `tokenType` (string) - Type of the token (e.g., "Bearer").
|
|
239
245
|
|
|
240
|
-
- `token` (string) -
|
|
246
|
+
- `token` (string) - Bearer access token. It expires after **2 hours of inactivity** (see **Token expiration**).
|
|
241
247
|
|
|
242
248
|
|
|
243
249
|
---
|
|
@@ -255,7 +261,6 @@ If these limits are exceeded, the API will temporarily reject additional calls,
|
|
|
255
261
|
| 400 | `validators.secretKey.required` | `El campo secretKey es obligatorio.` | `secretKey` is absent |
|
|
256
262
|
| 400 | `validators.secretKey.isString` | `El campo secretKey debe ser de tipo string` | `secretKey` is not a string |
|
|
257
263
|
| 400 | `validators.secretKey.isNotEmpty` | `El campo secretKey no puede estar vacío.` | `secretKey` is empty or whitespace-only |
|
|
258
|
-
| 400 | — | `The saveSession field must be of type boolean.` | `saveSession` is present but not a boolean |
|
|
259
264
|
| 400 | `auth.invalid` | `Credenciales inválidas` | User does not exist or incorrect password |
|
|
260
265
|
| 400 | `user.blocked` | `Estás bloqueado` | User is blocked — do not retry; contact support (body may include `notify: true`) |
|
|
261
266
|
| 400 | `auth.invalid.TimeOuthLoginFaild` | `No se ha superado el tiempo de bloqueo por intentos` | Account temporarily locked after failed login attempts. Body includes `code: 5002` and optionally `diferentTimes` (minutes remaining before unlock) |
|
|
@@ -858,19 +863,67 @@ The response will include the results of the query in case of success.
|
|
|
858
863
|
| ownAgreementId | null | Campo del body: ownAgreementId |
|
|
859
864
|
| data | object | Campo del body: data |
|
|
860
865
|
|
|
861
|
-
### `
|
|
866
|
+
### `query_convenio_vendo`
|
|
862
867
|
|
|
863
|
-
|
|
868
|
+
---
|
|
869
|
+
|
|
870
|
+
### Description
|
|
871
|
+
|
|
872
|
+
This HTTP POST request is used to perform a custom query on the platform. The request body should be sent with the necessary parameters for the query in the format specified by the QueryBody object. The response will include the results of the query in case of success.
|
|
873
|
+
|
|
874
|
+
---
|
|
875
|
+
|
|
876
|
+
### Request Body Schema
|
|
877
|
+
|
|
878
|
+
- productId (number) `required`: Identifier of the product to perform the query.
|
|
879
|
+
|
|
880
|
+
- queryType (string) `required`: Type of query to be performed.
|
|
881
|
+
|
|
882
|
+
- ownAgreementId (null): Identifier of the own agreement, if applicable.
|
|
883
|
+
|
|
884
|
+
- data (object) `required`: Additional data for the query.
|
|
885
|
+
|
|
886
|
+
- reference (string) `required`: Reference for the query.
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
---
|
|
890
|
+
|
|
891
|
+
### Response Body Schema
|
|
892
|
+
|
|
893
|
+
- message (string): Response message.
|
|
894
|
+
|
|
895
|
+
- messageCode (string): Code related to the response message.
|
|
896
|
+
|
|
897
|
+
- data (object): Response data object.
|
|
898
|
+
|
|
899
|
+
- payload (object): Payload data.
|
|
900
|
+
|
|
901
|
+
- amount (number): Amount related to the product.
|
|
902
|
+
|
|
903
|
+
- productId (number): ID of the product.
|
|
904
|
+
|
|
905
|
+
- productName (string): Name of the product.
|
|
906
|
+
|
|
907
|
+
- reference (string): Reference related to the query.
|
|
908
|
+
|
|
909
|
+
- hashEchoData (string): Hash echo data.
|
|
910
|
+
|
|
911
|
+
- hash (string): Hash value.
|
|
912
|
+
|
|
913
|
+
- amountEditable (boolean): Indicates if the amount is editable.
|
|
914
|
+
|
|
915
|
+
**Parámetros:**
|
|
864
916
|
|
|
865
|
-
|
|
917
|
+
| Name | Type | Description |
|
|
918
|
+
| --- | --- | --- |
|
|
919
|
+
| productId | number | Campo del body: productId |
|
|
920
|
+
| queryType | string | Campo del body: queryType |
|
|
921
|
+
| ownAgreementId | number | Campo del body: ownAgreementId |
|
|
922
|
+
| data | object | Campo del body: data |
|
|
866
923
|
|
|
867
|
-
|
|
924
|
+
### `query`
|
|
868
925
|
|
|
869
|
-
|
|
870
|
-
|-------|---------------|
|
|
871
|
-
| productId | 1587 |
|
|
872
|
-
| queryType | "BILLData" |
|
|
873
|
-
| data.reference | "63440172" |
|
|
926
|
+
**Important:** This request will be processed within a timeout of **30,000 milliseconds (30 seconds)**.
|
|
874
927
|
|
|
875
928
|
**Parámetros:**
|
|
876
929
|
|
|
@@ -978,20 +1031,6 @@ Allows performing a sale on the platform. Send the request body with the necessa
|
|
|
978
1031
|
|
|
979
1032
|
- `message`: String representing the message (required)
|
|
980
1033
|
|
|
981
|
-
### Test Data
|
|
982
|
-
|
|
983
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
984
|
-
|
|
985
|
-
| Field | Example Value |
|
|
986
|
-
|-------|---------------|
|
|
987
|
-
| amount | 9999 |
|
|
988
|
-
| productId | 1587 |
|
|
989
|
-
| sellType | "Bill" |
|
|
990
|
-
| data.agreement | 2010910 |
|
|
991
|
-
| data.reference | "63440172" |
|
|
992
|
-
| data.cellphone | "3203550000" |
|
|
993
|
-
| data.hashEchoData | "eyJhZ3JlZW1lbnRJZCI6MzM3NDMsInJlZmVyZW5jZTEiOiI2MzQ0MDE3MiIsInJlZmVyZW5jZTIiOm51bGwsImFtb3VudCI6OTk5OSwiYWdyZWVtZW50TWVzc2FnZSI6IiIsImFncmVlbWVudENvZGUiOiIwMCIsInJlcXVpcmVzQW1vdW50IjoiMCIsImFkaXRpb25hbFZhbHVlNTRFY28iOiIwMTIzNDU2Nzg5MCIsImFkaXRpb25hbFZhbHVlNjJFY28iOiIxNTE2NTc4OTU1NjM0MjgxNjM4NzM5OTAyMjk1IiwiYWNjb3VudERhdGFBY3JlZGl0ZWQiOiI0NzU3NjY3MjA1ODE2Mzg3Mzk5MDIyOTUyMjc2IiwiYWRkaXRpb25hbENvbXBhbnlDb2RlIjoiMTUxNjU3ODk1NTYzNDI4MjgwNjI4MzcwMTIxMiIsImRhdGUiOiIyMDI2LTAzLTEwIiwidHJhY2UiOjUxMjF9" |
|
|
994
|
-
|
|
995
1034
|
**Parámetros:**
|
|
996
1035
|
|
|
997
1036
|
| Name | Type | Description |
|
|
@@ -1061,19 +1100,6 @@ The following payload is required for performing a custom query:
|
|
|
1061
1100
|
|
|
1062
1101
|
- `license`: (string, optional) The license plate of the vehicle.
|
|
1063
1102
|
|
|
1064
|
-
### Test Data
|
|
1065
|
-
|
|
1066
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
1067
|
-
|
|
1068
|
-
| Field | Example Value |
|
|
1069
|
-
|-------|---------------|
|
|
1070
|
-
| queryType | "SOATData" |
|
|
1071
|
-
| productId | 91 |
|
|
1072
|
-
| docType | "NIT" |
|
|
1073
|
-
| document | "819000939" |
|
|
1074
|
-
| cellphone | "3200000000" |
|
|
1075
|
-
| license | "NAC854" |
|
|
1076
|
-
|
|
1077
1103
|
**Parámetros:**
|
|
1078
1104
|
|
|
1079
1105
|
| Name | Type | Description |
|
|
@@ -1176,35 +1202,6 @@ The following payload is required for performing a custom sell:
|
|
|
1176
1202
|
|
|
1177
1203
|
After the sale has been successfully completed, the response will follow a structure similar to the following. In this response, important information is provided, such as the balance of the main wallet and the balance of the profit wallet. Additionally, within the 'billData' object, you will find the fundamental information necessary to generate the sales receipt that will be delivered to the end customer. It is important to note that this step is mandatory, as it is a direct requirement from AXA Colpatria.
|
|
1178
1204
|
|
|
1179
|
-
### Test Data
|
|
1180
|
-
|
|
1181
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
1182
|
-
|
|
1183
|
-
| Field | Example Value |
|
|
1184
|
-
|-------|---------------|
|
|
1185
|
-
| productId | 91 |
|
|
1186
|
-
| amount | 557400 |
|
|
1187
|
-
| data.amount.amount | 556400 |
|
|
1188
|
-
| data.amount.runt | 2100 |
|
|
1189
|
-
| data.amount.prima | 364700 |
|
|
1190
|
-
| data.amount.contributions | 189600 |
|
|
1191
|
-
| data.amount.valueDiscountLaw | 0 |
|
|
1192
|
-
| data.amount.valueDiscountTotal | 0 |
|
|
1193
|
-
| data.amount.valuePayDiscount | 556400 |
|
|
1194
|
-
| data.amount.amountAdministrative | 566 |
|
|
1195
|
-
| data.amount.amountTotal | 557400 |
|
|
1196
|
-
| data.amount.dateStart | "2024-06-04" |
|
|
1197
|
-
| data.amount.dateEnd | "2025-06-03" |
|
|
1198
|
-
| data.amount.discount | 0 |
|
|
1199
|
-
| data.license | "EJV885" |
|
|
1200
|
-
| data.hashEchoData | "eyJpZFRyYW5zYWNjaW9uIjoiMmE2MDhjY2YtZjdiOS00ZGM1LTg2OTQtYTAyY2E0ODNkOWE4IiwiaWRDb3JyZWxhY2lvbiI6MTcxNzUzNDY0MTc1MH0=" |
|
|
1201
|
-
| data.cifrateAmount.hash | "eyJhbW91bnQiOjU1NzQwMH0=" |
|
|
1202
|
-
| data.cifrateAmount.hashEchoData | "ef3e40f13fa0430eb1dfa9a8e499e3a4ea81c42159b5ee3eccac88d8ef47198e32d28339fcf656704009a0b05802363b3016d921bcfd6aa8920558535aa75218" |
|
|
1203
|
-
| data.userDetail.cellphone | "3200000000" |
|
|
1204
|
-
| data.userDetail.email | "test@email.com" |
|
|
1205
|
-
| data.userDetail.document | "860002964" |
|
|
1206
|
-
| data.userDetail.docType | "NIT" |
|
|
1207
|
-
|
|
1208
1205
|
**Parámetros:**
|
|
1209
1206
|
|
|
1210
1207
|
| Name | Type | Description |
|
|
@@ -1339,18 +1336,6 @@ The following payload is required for performing a custom query:
|
|
|
1339
1336
|
|
|
1340
1337
|
**Important:** This request will be processed within a timeout of **30,000 milliseconds (30 seconds)**.
|
|
1341
1338
|
|
|
1342
|
-
### Test Data
|
|
1343
|
-
|
|
1344
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
1345
|
-
|
|
1346
|
-
| Field | Example Value |
|
|
1347
|
-
|-------|---------------|
|
|
1348
|
-
| productId | 1014006 |
|
|
1349
|
-
| documentType | 1 |
|
|
1350
|
-
| document | "1032363500" |
|
|
1351
|
-
| queryType | "SOATFullData" |
|
|
1352
|
-
| license | "XAZ975" |
|
|
1353
|
-
|
|
1354
1339
|
**Parámetros:**
|
|
1355
1340
|
|
|
1356
1341
|
| Name | Type | Description |
|
|
@@ -1443,16 +1428,6 @@ The following payload is required for performing a custom query:
|
|
|
1443
1428
|
|
|
1444
1429
|
- `license`: (string, required) The license plate of the vehicle.
|
|
1445
1430
|
|
|
1446
|
-
### Test Data
|
|
1447
|
-
|
|
1448
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
1449
|
-
|
|
1450
|
-
| Field | Example Value |
|
|
1451
|
-
|-------|---------------|
|
|
1452
|
-
| productId | 1014006 |
|
|
1453
|
-
| queryType | "SOATPolicy" |
|
|
1454
|
-
| license | "XAZ975" |
|
|
1455
|
-
|
|
1456
1431
|
**Parámetros:**
|
|
1457
1432
|
|
|
1458
1433
|
| Name | Type | Description |
|
|
@@ -1941,87 +1916,6 @@ The following payload is required for performing a custom sell:
|
|
|
1941
1916
|
|
|
1942
1917
|
After the sale has been successfully completed, the response will follow a structure similar to the following. **This response will be returned within a timeout of 120,000 milliseconds (2 minutes).** In this response, important information is provided, such as the balance of the main wallet and the balance of the profit wallet. Additionally, within the 'billData' object, you will find the fundamental information necessary to generate the sales receipt that will be delivered to the end customer.
|
|
1943
1918
|
|
|
1944
|
-
### Test Data
|
|
1945
|
-
|
|
1946
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
1947
|
-
|
|
1948
|
-
| Field | Example Value |
|
|
1949
|
-
|-------|---------------|
|
|
1950
|
-
| productId | 1014006 |
|
|
1951
|
-
| amount | 1413550 |
|
|
1952
|
-
| data.license | "ABC123" |
|
|
1953
|
-
| data.productId | 1014006 |
|
|
1954
|
-
| data.cellphone | "3001234567" |
|
|
1955
|
-
| data.document | "1111111" |
|
|
1956
|
-
| data.terminal.id | "123456" |
|
|
1957
|
-
| data.amount.TariffCode | "920" |
|
|
1958
|
-
| data.amount.InsurancePremium | 907900 |
|
|
1959
|
-
| data.amount.InsuranceTax | 453950 |
|
|
1960
|
-
| data.amount.InsuranceFine | 1700 |
|
|
1961
|
-
| data.amount.Total | 1363550 |
|
|
1962
|
-
| data.amount.TotalWithDiscountAmount | 1363550 |
|
|
1963
|
-
| data.amount.DiscountAmount | 0 |
|
|
1964
|
-
| data.amount.ElectricDiscount | 0 |
|
|
1965
|
-
| data.amount.PercentageElectricDiscount | 0 |
|
|
1966
|
-
| data.amount.InsurancePremiumFormatted | "$907.900" |
|
|
1967
|
-
| data.amount.InsuranceTaxFormatted | "$453.950" |
|
|
1968
|
-
| data.amount.InsuranceFineFormatted | "$1.700" |
|
|
1969
|
-
| data.amount.TotalFormatted | "$1.363.550" |
|
|
1970
|
-
| data.amount.DiscountAmountFormatted | "$0" |
|
|
1971
|
-
| data.amount.TotalWithDiscountAmountFormatted | "$1.363.550" |
|
|
1972
|
-
| data.amount.createdAt | "2020-02-20T10:23:24.000Z" |
|
|
1973
|
-
| data.amount.dateStart | "2020-02-20" |
|
|
1974
|
-
| data.amount.dateEnd | "2021-02-19" |
|
|
1975
|
-
| data.amount.amount | 1413550 |
|
|
1976
|
-
| data.amount.amountDiscount | 0 |
|
|
1977
|
-
| data.amount.amountOthers | 50000 |
|
|
1978
|
-
| data.amount.amountTotal | 1413550 |
|
|
1979
|
-
| data.amount.hash | "ba931ea8d2b57c9248ec4285c45efdddfdfff4d8" |
|
|
1980
|
-
| data.amount.runt | 1700 |
|
|
1981
|
-
| data.amount.codeFasecolda | 0 |
|
|
1982
|
-
| data.amount.typeCost | 0 |
|
|
1983
|
-
| data.amount.Law2161Discount | 0 |
|
|
1984
|
-
| data.amount.discount | 0 |
|
|
1985
|
-
| data.vehDetail.vehicleLineId | 5560 |
|
|
1986
|
-
| data.vehDetail.vehicleClassId | 8 |
|
|
1987
|
-
| data.vehDetail.vehicleClassMinistryId | 28 |
|
|
1988
|
-
| data.vehDetail.serviceTypeId | 2 |
|
|
1989
|
-
| data.vehDetail.vehicleBodyTypeId | 8 |
|
|
1990
|
-
| data.vehDetail.vehicleDescription | "NISSAN URVAN - 2012" |
|
|
1991
|
-
| data.vehDetail.vehDescription | "NISSAN URVAN - 2012" |
|
|
1992
|
-
| data.vehDetail.queryId | "" |
|
|
1993
|
-
| data.vehDetail.noSerie | "" |
|
|
1994
|
-
| data.vehDetail.noMotor | "Z0796987CM" |
|
|
1995
|
-
| data.vehDetail.noChasis | "JN1MG4E25Z0796987" |
|
|
1996
|
-
| data.vehDetail.cc | 2953 |
|
|
1997
|
-
| data.vehDetail.type | "CERRADA" |
|
|
1998
|
-
| data.vehDetail.gas | "" |
|
|
1999
|
-
| data.vehDetail.year | 2012 |
|
|
2000
|
-
| data.vehDetail.passengers | 16 |
|
|
2001
|
-
| data.vehDetail.brand | "NISSAN" |
|
|
2002
|
-
| data.vehDetail.brandId | 64 |
|
|
2003
|
-
| data.vehDetail.vin | "JN1MG4E25Z0796987" |
|
|
2004
|
-
| data.vehDetail.lineCode | "" |
|
|
2005
|
-
| data.vehDetail.service | "" |
|
|
2006
|
-
| data.vehDetail.zone | "" |
|
|
2007
|
-
| data.vehDetail.weight | 0 |
|
|
2008
|
-
| data.vehDetail.cityId | 5266 |
|
|
2009
|
-
| data.userDetail.name | "Nombre" |
|
|
2010
|
-
| data.userDetail.lastName | "Apellido" |
|
|
2011
|
-
| data.userDetail.docNumber | "1111111" |
|
|
2012
|
-
| data.userDetail.cellphone | "3001234567" |
|
|
2013
|
-
| data.userDetail.email | "contacto@gmail.com" |
|
|
2014
|
-
| data.userDetail.phone | "" |
|
|
2015
|
-
| data.userDetail.docType | 1 |
|
|
2016
|
-
| data.userDetail.address | "Calle 1 # 1 - 01" |
|
|
2017
|
-
| data.userDetail.cityCode | 76834 |
|
|
2018
|
-
| data.userDetail.stateCode | 76 |
|
|
2019
|
-
| data.userDetail.addressType | 1 |
|
|
2020
|
-
| data.userDetail.typePerson | "F" |
|
|
2021
|
-
| data.userDetail.gender | "M" |
|
|
2022
|
-
| data.userDetail.RegimenTypeId | "2" |
|
|
2023
|
-
| data.userDetail.RutId | 5 |
|
|
2024
|
-
|
|
2025
1919
|
**Parámetros:**
|
|
2026
1920
|
|
|
2027
1921
|
| Name | Type | Description |
|
|
@@ -2038,40 +1932,6 @@ Allows performing a sale on the platform. Send the request body with the necessa
|
|
|
2038
1932
|
|
|
2039
1933
|
**Important:** This response will be returned within a timeout of **60,000 milliseconds (60 seconds)**.
|
|
2040
1934
|
|
|
2041
|
-
---
|
|
2042
|
-
|
|
2043
|
-
## Request Schema
|
|
2044
|
-
|
|
2045
|
-
- `productId`: Number representing the product identifier (required)
|
|
2046
|
-
|
|
2047
|
-
- `amount`: Number representing the payment amount (required)
|
|
2048
|
-
|
|
2049
|
-
- `data`: Object containing additional transaction data (required)
|
|
2050
|
-
|
|
2051
|
-
- `cellphone`: String containing the customer's cellphone number (required)
|
|
2052
|
-
|
|
2053
|
-
- `document`: String containing the customer's identification document number (required)
|
|
2054
|
-
|
|
2055
|
-
- `name`: String containing the customer's first name (required)
|
|
2056
|
-
|
|
2057
|
-
- `lastname`: String containing the customer's last name (required)
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
---
|
|
2061
|
-
|
|
2062
|
-
### Test Data
|
|
2063
|
-
|
|
2064
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2065
|
-
|
|
2066
|
-
| Field | Example Value |
|
|
2067
|
-
|-------|---------------|
|
|
2068
|
-
| productId | 603 |
|
|
2069
|
-
| amount | 100 |
|
|
2070
|
-
| data.cellphone | "3200000000" |
|
|
2071
|
-
| data.document | "1023900000" |
|
|
2072
|
-
| data.name | "Pachito" |
|
|
2073
|
-
| data.lastname | "Hernesto" |
|
|
2074
|
-
|
|
2075
1935
|
**Parámetros:**
|
|
2076
1936
|
|
|
2077
1937
|
| Name | Type | Description |
|
|
@@ -2090,28 +1950,6 @@ Allows performing a sale on the platform. Send the request body with the necessa
|
|
|
2090
1950
|
|
|
2091
1951
|
**Important:** This response will be returned within a timeout of **60,000 milliseconds (60 seconds)**.
|
|
2092
1952
|
|
|
2093
|
-
---
|
|
2094
|
-
|
|
2095
|
-
## Request Schema
|
|
2096
|
-
|
|
2097
|
-
- `productId`: Number representing the product identifier (required)
|
|
2098
|
-
|
|
2099
|
-
- `data`: Object containing additional transaction data (required)
|
|
2100
|
-
|
|
2101
|
-
- `cellphone`: String containing the customer's cellphone number (required)
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
---
|
|
2105
|
-
|
|
2106
|
-
### Test Data
|
|
2107
|
-
|
|
2108
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2109
|
-
|
|
2110
|
-
| Field | Example Value |
|
|
2111
|
-
|-------|---|
|
|
2112
|
-
| productId | 200048 |
|
|
2113
|
-
| data.cellphone | "3215302000" |
|
|
2114
|
-
|
|
2115
1953
|
**Parámetros:**
|
|
2116
1954
|
|
|
2117
1955
|
| Name | Type | Description |
|
|
@@ -2211,16 +2049,6 @@ Allows performing a bill payment operation on the platform. Send the request bod
|
|
|
2211
2049
|
|
|
2212
2050
|
**Important:** This response will be returned within a timeout of **60,000 milliseconds (60 seconds)**.
|
|
2213
2051
|
|
|
2214
|
-
### Test Data
|
|
2215
|
-
|
|
2216
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2217
|
-
|
|
2218
|
-
| Field | Example Value |
|
|
2219
|
-
|-------|---------------|
|
|
2220
|
-
| productId | 50 |
|
|
2221
|
-
| amount | 1000 |
|
|
2222
|
-
| data.cellphone | "3015874044" |
|
|
2223
|
-
|
|
2224
2052
|
**Parámetros:**
|
|
2225
2053
|
|
|
2226
2054
|
| Name | Type | Description |
|
|
@@ -2322,17 +2150,6 @@ Allows performing a sale on the platform. Send the request body with the necessa
|
|
|
2322
2150
|
|
|
2323
2151
|
**Important:** This response will be returned within a timeout of **60,000 milliseconds (60 seconds)**.
|
|
2324
2152
|
|
|
2325
|
-
### Test Data
|
|
2326
|
-
|
|
2327
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2328
|
-
|
|
2329
|
-
| Field | Example Value |
|
|
2330
|
-
|-------|---------------|
|
|
2331
|
-
| productId | 202 |
|
|
2332
|
-
| amount | 50 |
|
|
2333
|
-
| data.cellphone | "3015874029" |
|
|
2334
|
-
| data.email | "correo@refacil.com" |
|
|
2335
|
-
|
|
2336
2153
|
**Parámetros:**
|
|
2337
2154
|
|
|
2338
2155
|
| Name | Type | Description |
|
|
@@ -2428,16 +2245,6 @@ Allows performing a bill payment operation on the platform. Send the request bod
|
|
|
2428
2245
|
|
|
2429
2246
|
- `message`: String representing the message (required)
|
|
2430
2247
|
|
|
2431
|
-
### Test Data
|
|
2432
|
-
|
|
2433
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2434
|
-
|
|
2435
|
-
| Field | Example Value |
|
|
2436
|
-
|-------|---------------|
|
|
2437
|
-
| productId | 1014005 |
|
|
2438
|
-
| data.cellphone | "3104784242" |
|
|
2439
|
-
| data.email | "fake@refacil.com" |
|
|
2440
|
-
|
|
2441
2248
|
**Parámetros:**
|
|
2442
2249
|
|
|
2443
2250
|
| Name | Type | Description |
|
|
@@ -2532,16 +2339,6 @@ Allows performing a bill payment operation on the platform. Send the request bod
|
|
|
2532
2339
|
|
|
2533
2340
|
- `message`: String representing the message (required)
|
|
2534
2341
|
|
|
2535
|
-
### Test Data
|
|
2536
|
-
|
|
2537
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2538
|
-
|
|
2539
|
-
| Field | Example Value |
|
|
2540
|
-
|-------|---------------|
|
|
2541
|
-
| productId | 100777 |
|
|
2542
|
-
| data.cellphone | "3104784242" |
|
|
2543
|
-
| data.email | "fake@refacil.com" |
|
|
2544
|
-
|
|
2545
2342
|
**Parámetros:**
|
|
2546
2343
|
|
|
2547
2344
|
| Name | Type | Description |
|
|
@@ -2636,16 +2433,6 @@ Allows performing a bill payment operation on the platform. Send the request bod
|
|
|
2636
2433
|
|
|
2637
2434
|
- `message`: String representing the message (required)
|
|
2638
2435
|
|
|
2639
|
-
### Test Data
|
|
2640
|
-
|
|
2641
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2642
|
-
|
|
2643
|
-
| Field | Example Value |
|
|
2644
|
-
|-------|---------------|
|
|
2645
|
-
| productId | 1014004 |
|
|
2646
|
-
| data.cellphone | "3104784242" |
|
|
2647
|
-
| data.email | "fake@refacil.com" |
|
|
2648
|
-
|
|
2649
2436
|
**Parámetros:**
|
|
2650
2437
|
|
|
2651
2438
|
| Name | Type | Description |
|
|
@@ -2653,7 +2440,7 @@ Use the following example values to test this endpoint in the QA environment:
|
|
|
2653
2440
|
| data | object | Campo del body: data |
|
|
2654
2441
|
| productId | number | Campo del body: productId |
|
|
2655
2442
|
|
|
2656
|
-
### `
|
|
2443
|
+
### `query_25`
|
|
2657
2444
|
|
|
2658
2445
|
---
|
|
2659
2446
|
|
|
@@ -2710,19 +2497,6 @@ If the request fails with the errorCode `product.errors.disabled` or a similar c
|
|
|
2710
2497
|
|
|
2711
2498
|
**Important:** This request will be processed within a timeout of **30,000 milliseconds (30 seconds)**.
|
|
2712
2499
|
|
|
2713
|
-
### Test Data
|
|
2714
|
-
|
|
2715
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2716
|
-
|
|
2717
|
-
| Field | Example Value |
|
|
2718
|
-
|-------|---------------|
|
|
2719
|
-
| queryType | "ConfirmData" |
|
|
2720
|
-
| productId | 231 |
|
|
2721
|
-
| data.carrierId | 231 |
|
|
2722
|
-
| data.cellphone | "3203550000" |
|
|
2723
|
-
| data.amount | 10000 |
|
|
2724
|
-
| data.reference | "1234567" |
|
|
2725
|
-
|
|
2726
2500
|
**Parámetros:**
|
|
2727
2501
|
|
|
2728
2502
|
| Name | Type | Description |
|
|
@@ -2832,19 +2606,6 @@ The timeout value specified below is directly established by the provider and mu
|
|
|
2832
2606
|
|
|
2833
2607
|
- `message`: String representing the message (required)
|
|
2834
2608
|
|
|
2835
|
-
### Test Data
|
|
2836
|
-
|
|
2837
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2838
|
-
|
|
2839
|
-
| Field | Example Value |
|
|
2840
|
-
|-------|---------------|
|
|
2841
|
-
| productId | 231 |
|
|
2842
|
-
| amount | 10000 |
|
|
2843
|
-
| data.plan | "AP" |
|
|
2844
|
-
| data.reference | "1234567" |
|
|
2845
|
-
| data.cellphone | "3203550000" |
|
|
2846
|
-
| data.hashEchoData | "eyJub21icmVfY2xpZW50ZSI6IkVMU1kgU0VyVklDRSIsImRpcmVjY2lvbiI6IlVSQiBWSUxMQSBWSUNUT1JJQSBDQVNBIDEwMyAtIFNBTiBNQVJUSU4iLCJkbmlfY2xpZW50ZSI6IjM5MDIyMDMxIiwiY29udHJhdG8iOiIxMjM0NTY3IiwidmFsb3JfdmVudGEiOiIxMDAwMCIsInBsYW4iOiIiLCJ0eXBlIjoiIn0=" |
|
|
2847
|
-
|
|
2848
2609
|
**Parámetros:**
|
|
2849
2610
|
|
|
2850
2611
|
| Name | Type | Description |
|
|
@@ -2855,7 +2616,7 @@ Use the following example values to test this endpoint in the QA environment:
|
|
|
2855
2616
|
| sellType | string | Campo del body: sellType |
|
|
2856
2617
|
| hash | string | Campo del body: hash |
|
|
2857
2618
|
|
|
2858
|
-
### `
|
|
2619
|
+
### `query_27`
|
|
2859
2620
|
|
|
2860
2621
|
---
|
|
2861
2622
|
|
|
@@ -2924,21 +2685,6 @@ If the request fails with the errorCode `product.errors.disabled` or a similar c
|
|
|
2924
2685
|
|
|
2925
2686
|
**Important:** This request will be processed within a timeout of **30,000 milliseconds (30 seconds)**.
|
|
2926
2687
|
|
|
2927
|
-
### Test Data
|
|
2928
|
-
|
|
2929
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
2930
|
-
|
|
2931
|
-
| Field | Example Value |
|
|
2932
|
-
|-------|---------------|
|
|
2933
|
-
| queryType | "ConfirmData" |
|
|
2934
|
-
| productId | 230 |
|
|
2935
|
-
| data.carrierId | 230 |
|
|
2936
|
-
| data.cellphone | "3203550000" |
|
|
2937
|
-
| data.amount | 10000 |
|
|
2938
|
-
| data.reference | "1234567" |
|
|
2939
|
-
| data.plan | "AP" |
|
|
2940
|
-
| data.type | "PT" |
|
|
2941
|
-
|
|
2942
2688
|
**Parámetros:**
|
|
2943
2689
|
|
|
2944
2690
|
| Name | Type | Description |
|
|
@@ -2948,7 +2694,7 @@ Use the following example values to test this endpoint in the QA environment:
|
|
|
2948
2694
|
| data | object | Campo del body: data |
|
|
2949
2695
|
| ownAgreementId | null | Campo del body: ownAgreementId |
|
|
2950
2696
|
|
|
2951
|
-
### `
|
|
2697
|
+
### `sell_28`
|
|
2952
2698
|
|
|
2953
2699
|
---
|
|
2954
2700
|
|
|
@@ -3061,22 +2807,6 @@ The timeout value specified below is directly established by the provider and mu
|
|
|
3061
2807
|
|
|
3062
2808
|
- `message`: String representing the message (required)
|
|
3063
2809
|
|
|
3064
|
-
### Test Data
|
|
3065
|
-
|
|
3066
|
-
Use the following example values to test this endpoint in the QA environment:
|
|
3067
|
-
|
|
3068
|
-
| Field | Example Value |
|
|
3069
|
-
|-------|---------------|
|
|
3070
|
-
| productId | 230 |
|
|
3071
|
-
| amount | 10000 |
|
|
3072
|
-
| data.cellphone | "3203550000" |
|
|
3073
|
-
| data.plan | "AP" |
|
|
3074
|
-
| data.reference | "1234567" |
|
|
3075
|
-
| data.type | "PT" |
|
|
3076
|
-
| data.valorAseo | 5000 |
|
|
3077
|
-
| data.valorEnergia | 5000 |
|
|
3078
|
-
| data.hashEchoData | "eyJub21icmVfY2xpZW50ZSI6IkVMU1kgU0VyVklDRSIsImRpcmVjY2lvbiI6IlVSQiBWSUxMQSBWSUNUT1JJQSBDQVNBIDEwMyAtIFNBTiBNQVJUSU4iLCJkbmlfY2xpZW50ZSI6IjM5MDIyMDMxIiwiY29udHJhdG8iOiIxMjM0NTY3IiwidmFsb3JfdmVudGEiOiIxMDAwMCIsInZhbG9yX2FzZW8iOjUwMDAsInZhbG9yX2VuZXJnaWEiOjUwMDAsImNlbHVsYXIiOiIzMjAzNTUwMDAwIiwiaWRDb25maXJtYWNpb24iOiJzZGpha3NkamRqYS1kYXMwZGRhbnNkMDItZnNhZGthc2RrNTYiLCJwbGFuIjoiQVAiLCJ0eXBlIjoiUFQifQ==" |
|
|
3079
|
-
|
|
3080
2810
|
**Parámetros:**
|
|
3081
2811
|
|
|
3082
2812
|
| Name | Type | Description |
|
|
@@ -3087,7 +2817,7 @@ Use the following example values to test this endpoint in the QA environment:
|
|
|
3087
2817
|
| sellType | string | Campo del body: sellType |
|
|
3088
2818
|
| hash | string | Campo del body: hash |
|
|
3089
2819
|
|
|
3090
|
-
### `
|
|
2820
|
+
### `query_29`
|
|
3091
2821
|
|
|
3092
2822
|
Here you will find all the endpoints related to Transfiya correspondent selling.
|
|
3093
2823
|
|
|
@@ -3335,23 +3065,6 @@ curl --location --globoff 'https://acme.refacil.local/transfiYaNotifications' \
|
|
|
3335
3065
|
|
|
3336
3066
|
**Step 9: Transaction marked as failed:** If the transaction status changes to "REJECTED," the transaction is officially marked as failed within the system.
|
|
3337
3067
|
|
|
3338
|
-
---
|
|
3339
|
-
|
|
3340
|
-
## Request Schema
|
|
3341
|
-
|
|
3342
|
-
- `productId`: Number representing the product identifier (required)
|
|
3343
|
-
|
|
3344
|
-
- `amount`: Number representing the transaction amount in cents (required)
|
|
3345
|
-
|
|
3346
|
-
- `webhookUrl`: String containing the URL to receive transaction status notifications (required)
|
|
3347
|
-
|
|
3348
|
-
- `data`: Object containing additional transaction data (required)
|
|
3349
|
-
|
|
3350
|
-
- `cellphone`: String containing the customer's cellphone number (required)
|
|
3351
|
-
|
|
3352
|
-
- `bankName`: String containing the target bank name (required)
|
|
3353
|
-
|
|
3354
|
-
|
|
3355
3068
|
---
|
|
3356
3069
|
|
|
3357
3070
|
### Test Phone Numbers
|
|
@@ -3519,23 +3232,6 @@ Automatically rejected: 3002491283
|
|
|
3519
3232
|
|
|
3520
3233
|
- **No commission processing**: Since the transaction failed, no commissions are processed for this transaction.
|
|
3521
3234
|
|
|
3522
|
-
---
|
|
3523
|
-
|
|
3524
|
-
## Request Schema
|
|
3525
|
-
|
|
3526
|
-
- `productId`: Number representing the product identifier (required)
|
|
3527
|
-
|
|
3528
|
-
- `amount`: Number representing the deposit amount in cents (required)
|
|
3529
|
-
|
|
3530
|
-
- `webhookUrl`: String containing the URL to receive transaction status notifications (required)
|
|
3531
|
-
|
|
3532
|
-
- `data`: Object containing additional transaction data (required)
|
|
3533
|
-
|
|
3534
|
-
- `cellphone`: String containing the customer's cellphone number (required)
|
|
3535
|
-
|
|
3536
|
-
- `bankName`: String containing the target bank name for the deposit (required)
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
3235
|
---
|
|
3540
3236
|
|
|
3541
3237
|
### Test Phone Numbers
|