refacil-pay-mcp 1.1.4 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -12
- package/dist/config.d.ts +1 -0
- package/dist/config.js +2 -0
- package/dist/config.js.map +1 -1
- package/dist/core/resources.js +25 -18
- package/dist/core/resources.js.map +1 -1
- package/dist/core/tools.d.ts +1 -1
- package/dist/core/tools.js +38 -35
- package/dist/core/tools.js.map +1 -1
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -220,8 +220,6 @@ This service allows security validation for the execution of a transaction on th
|
|
|
220
220
|
|
|
221
221
|
> 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.
|
|
222
222
|
|
|
223
|
-
Generates a transactional token for payment link service.
|
|
224
|
-
|
|
225
223
|
**Parámetros:**
|
|
226
224
|
|
|
227
225
|
| Name | Type | Description |
|
|
@@ -240,8 +238,6 @@ This service allows security validation for the execution of a transaction on th
|
|
|
240
238
|
|
|
241
239
|
> 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.
|
|
242
240
|
|
|
243
|
-
Generates a transactional token for payment method service.
|
|
244
|
-
|
|
245
241
|
**Parámetros:**
|
|
246
242
|
|
|
247
243
|
| Name | Type | Description |
|
|
@@ -260,8 +256,6 @@ This service allows security validation for the execution of a transaction on th
|
|
|
260
256
|
|
|
261
257
|
> 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.
|
|
262
258
|
|
|
263
|
-
Generates a transactional token for withdraw service.
|
|
264
|
-
|
|
265
259
|
**Parámetros:**
|
|
266
260
|
|
|
267
261
|
| Name | Type | Description |
|
|
@@ -280,8 +274,6 @@ This service allows security validation for the execution of a transaction on th
|
|
|
280
274
|
|
|
281
275
|
> 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.
|
|
282
276
|
|
|
283
|
-
Generates a transactional token for creating merchant keys.
|
|
284
|
-
|
|
285
277
|
**Parámetros:**
|
|
286
278
|
|
|
287
279
|
| Name | Type | Description |
|
|
@@ -300,8 +292,6 @@ This service allows security validation for the execution of a transaction on th
|
|
|
300
292
|
|
|
301
293
|
> 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.
|
|
302
294
|
|
|
303
|
-
Generates a transactional token for canceling merchant keys.
|
|
304
|
-
|
|
305
295
|
**Parámetros:**
|
|
306
296
|
|
|
307
297
|
| Name | Type | Description |
|
|
@@ -367,9 +357,10 @@ The table below lists the available payment methods along with their correspondi
|
|
|
367
357
|
| `155` | Cash-in via **Transfiya Recaudo** | 43,200 |
|
|
368
358
|
| `163` | Cash-in via **TPaga** | 43,200 |
|
|
369
359
|
| `248` | Cash-in via **QR Interoperable** | N/A |
|
|
360
|
+
| `250` | Cash-in via **Llaves Bre-B** | 300 |
|
|
370
361
|
|
|
371
362
|
> ⚠ **Important:**
|
|
372
|
-
The value provided in the
|
|
363
|
+
The value provided in the expiresIn field **must be greater than or equal** to the minimum expiration defined for the selected payment method. **This does not apply to dynamic keys, which always expire 5 minutes after creation.**
|
|
373
364
|
|
|
374
365
|
|
|
375
366
|
---
|
|
@@ -626,6 +617,68 @@ This is **not** an error in our platform.
|
|
|
626
617
|
|
|
627
618
|
---
|
|
628
619
|
|
|
620
|
+
### **Llaves** Dinámicas **Bre-B**
|
|
621
|
+
|
|
622
|
+
For this method, the following fields are **required**:
|
|
623
|
+
|
|
624
|
+
- `cellphone`
|
|
625
|
+
|
|
626
|
+
- `docNumber`
|
|
627
|
+
|
|
628
|
+
- `docType`
|
|
629
|
+
|
|
630
|
+
- `merchantId`
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
You 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.
|
|
634
|
+
|
|
635
|
+
> ⚠ **Prerequisite:**
|
|
636
|
+
The merchant must complete the **Merchant Enrollment** process before using this method.
|
|
637
|
+
See the _Merchant Enrollment_ section for setup details.
|
|
638
|
+
|
|
639
|
+
> 🔁 **Open Resource:**
|
|
640
|
+
The **Llaves Dinamicas Bre-B** operates as an _open resource_, meaning the generated KEY can be used multiple times by the same user.
|
|
641
|
+
|
|
642
|
+
> ⚙️ **Technical Note — Dynamic Key Behavior:**
|
|
643
|
+
Dynamic keys may receive multiple money transfers due to current limitations in the Redeban system.
|
|
644
|
+
This behavior does not represent an error or malfunction in our platform.
|
|
645
|
+
**Additionally, dynamic keys have a fixed validity period of 5 minutes, and this duration cannot be modified.**
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
#### Behavior Details
|
|
649
|
+
|
|
650
|
+
- Redeban does not automatically invalidate a dynamic KEY after its first send.
|
|
651
|
+
|
|
652
|
+
- As a result, the same KEY may generate multiple transaction records.
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
#### Recommendations
|
|
656
|
+
|
|
657
|
+
- Implement **application-level validation** to detect multiple payments from the same KEY.
|
|
658
|
+
|
|
659
|
+
- Monitor dynamic KEY transactions and confirm status before marking payments as completed.
|
|
660
|
+
|
|
661
|
+
- Inform end-users to verify the success of a transaction before rescanning.
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
#### Future Considerations
|
|
665
|
+
|
|
666
|
+
- Stay updated with interoperability provider announcements to adjust integrations accordingly.
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
``` json
|
|
670
|
+
"paymentMethod": {
|
|
671
|
+
"id": 250,
|
|
672
|
+
"cellphone": "string",
|
|
673
|
+
"docType": "string",
|
|
674
|
+
"docNumber": "string",
|
|
675
|
+
"merchantId": "string"
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
---
|
|
681
|
+
|
|
629
682
|
## 📥 Request Body Parameters
|
|
630
683
|
|
|
631
684
|
| **Field** | **Type** | **Required** | **Description** |
|
|
@@ -808,7 +861,7 @@ Body
|
|
|
808
861
|
|
|
809
862
|
| Name | Type | Description |
|
|
810
863
|
| --- | --- | --- |
|
|
811
|
-
| userId |
|
|
864
|
+
| userId | number | Campo del body: userId |
|
|
812
865
|
|
|
813
866
|
### `payment_transfiya_banks`
|
|
814
867
|
|
package/dist/config.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export declare const appConfig: {
|
|
|
9
9
|
readonly apiToken: string | undefined;
|
|
10
10
|
readonly username: string;
|
|
11
11
|
readonly password: string;
|
|
12
|
+
readonly secretKey: string;
|
|
12
13
|
readonly authEndpoint: string;
|
|
13
14
|
readonly tokenCacheTtl: number;
|
|
14
15
|
readonly mcpToken: string | undefined;
|
package/dist/config.js
CHANGED
|
@@ -50,6 +50,7 @@ const authEndpoint = process.env.AUTH_ENDPOINT || '';
|
|
|
50
50
|
const apiToken = process.env.API_TOKEN;
|
|
51
51
|
const username = process.env.USERNAME;
|
|
52
52
|
const password = process.env.PASSWORD;
|
|
53
|
+
const secretKey = process.env.SECRET_KEY || '';
|
|
53
54
|
export const appConfig = {
|
|
54
55
|
name: 'refacil-pay',
|
|
55
56
|
description: 'MCP para Refacil Pay API - Gestión de pagos y transacciones',
|
|
@@ -61,6 +62,7 @@ export const appConfig = {
|
|
|
61
62
|
apiToken,
|
|
62
63
|
username,
|
|
63
64
|
password,
|
|
65
|
+
secretKey,
|
|
64
66
|
authEndpoint,
|
|
65
67
|
tokenCacheTtl,
|
|
66
68
|
mcpToken: process.env.MCP_TOKEN ?? undefined
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,8BAA8B;AAC9B,MAAM,EAAE,CAAC;AAET,6BAA6B;AAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;AAEnG,0CAA0C;AAC1C,MAAM,eAAe,GAAG,CAAC,UAAU,EAAC,UAAU,EAAC,UAAU,EAAC,eAAe,CAAC,CAAC;AAC3E,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IACnD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG;QACf,gGAAgG;QAChG,UAAU;QACV,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACjE,GAAG;KACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,MAAM,IAAI,KAAK,CACb,6CAA6C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CACnF,CAAC;AACJ,CAAC;AAED,0CAA0C;AAC1C,MAAM,eAAe,GAAa,EAAE,CAAC;AACrC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACnC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,8CAA8C;QAC9C,MAAM,QAAQ,GAAG;YACf,gGAAgG;YAChG,UAAU;YACV,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YACzE,GAAG;SACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,IAAI,KAAK,CACb,6DAA6D,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAC3G,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,qEAAqE;QACrE,OAAO,CAAC,KAAK,CAAC,6CAA6C,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,OAAO,CAAC,KAAK,CAAC,uFAAuF,CAAC,CAAC;IACzG,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;AAEjF,uFAAuF;AACvF,sDAAsD;AACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;AAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC;AACrD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;AACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAS,CAAC;AACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,8BAA8B;AAC9B,MAAM,EAAE,CAAC;AAET,6BAA6B;AAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;AAEnG,0CAA0C;AAC1C,MAAM,eAAe,GAAG,CAAC,UAAU,EAAC,UAAU,EAAC,UAAU,EAAC,eAAe,CAAC,CAAC;AAC3E,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IACnD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG;QACf,gGAAgG;QAChG,UAAU;QACV,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACjE,GAAG;KACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,MAAM,IAAI,KAAK,CACb,6CAA6C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CACnF,CAAC;AACJ,CAAC;AAED,0CAA0C;AAC1C,MAAM,eAAe,GAAa,EAAE,CAAC;AACrC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACnC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,8CAA8C;QAC9C,MAAM,QAAQ,GAAG;YACf,gGAAgG;YAChG,UAAU;YACV,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YACzE,GAAG;SACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,IAAI,KAAK,CACb,6DAA6D,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAC3G,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,qEAAqE;QACrE,OAAO,CAAC,KAAK,CAAC,6CAA6C,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,OAAO,CAAC,KAAK,CAAC,uFAAuF,CAAC,CAAC;IACzG,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;AAEjF,uFAAuF;AACvF,sDAAsD;AACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;AAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC;AACrD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;AACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAS,CAAC;AACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAS,CAAC;AACvC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;AAE/C,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE,6DAA6D;IAC1E,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,QAAS;IAC9B,IAAI;IACJ,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa;IAC7E,QAAQ,EAAE,kBAAkB;IAC5B,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,YAAY;IACZ,aAAa;IACb,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,SAAS;CACpC,CAAC"}
|
package/dist/core/resources.js
CHANGED
|
@@ -9,7 +9,14 @@ export const resources = [
|
|
|
9
9
|
"name": "Refacil Pay API - API Documentation",
|
|
10
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
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
|
|
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 1 main items.\n\n## Available Folders\n\n- **Pay API 2.0**: Welcome to Refácil Pay in this space you will find all the information to make a successful connecti...\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/pay-api-2-0",
|
|
16
|
+
"name": "Pay API 2.0 - Documentation",
|
|
17
|
+
"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.",
|
|
18
|
+
"mimeType": "text/markdown",
|
|
19
|
+
"content": "# Pay API 2.0\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## Endpoints\n\n"
|
|
13
20
|
},
|
|
14
21
|
{
|
|
15
22
|
"uri": "postman://collection/refacil-pay-api/folder/authorization",
|
|
@@ -23,7 +30,7 @@ export const resources = [
|
|
|
23
30
|
"name": "Transactional token - Documentation",
|
|
24
31
|
"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
32
|
"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\
|
|
33
|
+
"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
34
|
},
|
|
28
35
|
{
|
|
29
36
|
"uri": "postman://collection/refacil-pay-api/folder/payments",
|
|
@@ -44,7 +51,7 @@ export const resources = [
|
|
|
44
51
|
"name": "Withdraw - Documentation",
|
|
45
52
|
"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
53
|
"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
|
|
54
|
+
"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 (optional)` | 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
55
|
},
|
|
49
56
|
{
|
|
50
57
|
"uri": "postman://collection/refacil-pay-api/folder/payment-information",
|
|
@@ -84,37 +91,37 @@ export const resources = [
|
|
|
84
91
|
{
|
|
85
92
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
86
93
|
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
87
|
-
"description": "
|
|
94
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
88
95
|
"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\
|
|
96
|
+
"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
97
|
},
|
|
91
98
|
{
|
|
92
99
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
93
100
|
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
94
|
-
"description": "
|
|
101
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
95
102
|
"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\
|
|
103
|
+
"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
104
|
},
|
|
98
105
|
{
|
|
99
106
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
100
107
|
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
101
|
-
"description": "
|
|
108
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
102
109
|
"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\
|
|
110
|
+
"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
111
|
},
|
|
105
112
|
{
|
|
106
113
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
107
114
|
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
108
|
-
"description": "
|
|
115
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
109
116
|
"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\
|
|
117
|
+
"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
118
|
},
|
|
112
119
|
{
|
|
113
120
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/trx-token/generate",
|
|
114
121
|
"name": "POST /trx-token/generate - Endpoint Documentation",
|
|
115
|
-
"description": "
|
|
122
|
+
"description": "| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| **service** \\* | string | Value of the service to be consumed |",
|
|
116
123
|
"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\
|
|
124
|
+
"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
125
|
},
|
|
119
126
|
{
|
|
120
127
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-in/generate/payment-link/token",
|
|
@@ -126,23 +133,23 @@ export const resources = [
|
|
|
126
133
|
{
|
|
127
134
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-in/generate/payment-method/token",
|
|
128
135
|
"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. |",
|
|
136
|
+
"description": "This endpoint allows you to **generate payment requests** through the available _cash-in_ methods.\n\n---\n\n### 💡 Overview\n\nThe table below lists the available payment methods along with their corresponding IDs and **minimum expiration times** (`expiresIn`) required when creating a payment request.\n\n| **Method ID** | **Description** | **Minimum Expiration (seconds)** |\n| --- | --- | --- |\n| `130` | Cash-in via **Nequi** | 43,200 |\n| `131` | Cash-in via **Daviplata** | 43,200 |\n| `133` | Cash-in via **PSE** | 1,800 |\n| `262` | Cash-in via **PSE Gateway** | 1,800 |\n| `134` | Cash-in via **IPay** | 43,200 |\n| `153` | Cash-in via **Recaudo Efectivo** | 86,400 |\n| `155` | Cash-in via **Transfiya Recaudo** | 43,200 |\n| `163` | Cash-in via **TPaga** | 43,200 |\n| `248` | Cash-in via **QR Interoperable** | N/A |\n| `250` | Cash-in via **Llaves Bre-B** | 300 |\n\n> ⚠ **Important:** \nThe value provided in the expiresIn field **must be greater than or equal** to the minimum expiration defined for the selected payment method. **This does not apply to dynamic keys, which always expire 5 minutes after creation.** \n \n\n---\n\n## 🧩 Payment Method Details\n\nEach payment method requires a specific object structure within the `\"paymentMethod\"` field.\n\n---\n\n### **Nequi**\n\n``` json\n\"paymentMethod\": {\n \"id\": 130,\n \"cellphone\": \"3105293225\"\n}\n\n ```\n\n---\n\n### **Daviplata**\n\n``` json\n\"paymentMethod\": {\n \"id\": 131,\n \"cellphone\": \"3208385715\"\n}\n\n ```\n\n---\n\n### **PSE**\n\nFor this payment method, depending on the `typePerson` selected, only specific document types are accepted:\n\n- **`typePerson`****:** **`\"0\"`** → corresponds to a **Natural Person** and only accepts the following values for `documentType`:\n \n - `RCN`\n \n - `TI`\n \n - `CC`\n \n - `TE`\n \n - `CE`\n \n - `PA`\n \n - `DIE`\n \n- **`typePerson`****:** **`\"1\"`** → corresponds to a **Legal Person** and only accepts the following value for `documentType`:\n \n - `NIT`\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 133,\n \"documentType\": \"CC\",\n \"typePerson\": \"0\",\n \"bankId\": \"string\",\n \"documentNumber\": \"string\",\n \"name\": \"string\",\n \"cellphone\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\"\n}\n\n ```\n\n---\n\n### **PSE Gateway**\n\nThis payment method enables direct integration with the PSE network for processing online bank payments. \nTo consume this product, it is required to have the following parameters previously configured and associated with your product:\n\n- `entity_code`\n \n- `service_code`\n \n- `company_ciiu`\n \n- `company_name`\n \n\nThese parameters identify your company within the PSE network and are necessary for successful transaction routing and validation.\n\n> 💬 **For more information or to request these credentials, please contact the support team.** \n \n\nThis method follows **the same structure and validation rules** as **PSE**, but must use the following identifier:\n\n``` json\n\"paymentMethod\": {\n \"id\": 262,\n \"documentType\": \"CC\",\n \"typePerson\": \"0\",\n \"bankId\": \"string\",\n \"documentNumber\": \"string\",\n \"name\": \"string\",\n \"cellphone\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\"\n}\n\n ```\n\nThe **PSE integration** relies heavily on the correct configuration of the `showSummary` and `returnUrl` parameters. \nThese parameters control the **user experience** and the **finalization flow** of the payment process.\n\n| Scenario | `showSummary` | `returnUrl` | Flow Description |\n| --- | --- | --- | --- |\n| **1\\. Standard Redirect (Default)** | `true` or not sent | ✅ Present | Displays a transaction summary screen with key payment details and retrieves the final transaction status. After the payment is completed, the user is redirected to the specified `returnUrl`. |\n| **2\\. Without Transaction Summary Screen** | `false` | ✅ Present | Skips the transaction summary screen and redirects the user directly to the `returnUrl`. In this case, the merchant’s system must display the transaction summary on the destination page. |\n\n> ⚠️ **Note:** \nFor **PSE** and **PSE Gateway**, it is **strongly recommended** to use `showSummary: true` along with a valid `returnUrl` to ensure a seamless customer experience and accurate transaction tracking. \n \n> 🔗 **See also:** \n \n\n- [Transaction Summary](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#45e0d76a-fabd-442e-9b17-e2f6b8354ec5)\n \n- [Transaction Status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799)\n \n\n---\n\n### **IPay**\n\n``` json\n\"paymentMethod\": {\n \"id\": 134\n}\n\n ```\n\n---\n\n### **Recaudo Efectivo**\n\n``` json\n\"paymentMethod\": {\n \"id\": 153\n}\n\n ```\n\n---\n\n### **Transfiya Recaudo**\n\n``` json\n\"paymentMethod\": {\n \"id\": 155,\n \"cellphone\": \"3105293225\"\n}\n\n ```\n\n---\n\n### **TPaga**\n\nThis payment method supports an optional parameter called `isQr`, which determines the type of resource returned in the `url` field:\n\n| **Value** | **Description** |\n| --- | --- |\n| `true` | The `url` field returns a link to a **QR code** displaying transaction details. |\n| `false` | The `url` field returns a **deeplink** to open directly in the TPAGA wallet app. |\n\n> 🧠 **Behavior:** \nIf `isQr` is not provided, the default behavior is equivalent to `isQr: false`. \nTransactions can only be completed **from a mobile device**. \nIf the request is made from a desktop or tablet, it is recommended to send `isQr: true` so the user can scan the QR from a mobile device. \n \n\n``` json\n\"paymentMethod\": {\n \"id\": 163,\n \"isQr\": false\n}\n\n ```\n\n---\n\n### **QR Interoperable**\n\nFor this method, the following fields are **optional**:\n\n- `cellphone`\n \n- `documentNumber`\n \n- `documentType`\n \n- `merchantId`\n \n\nThe service can function using only the payment method ID; however, providing these optional fields can **improve response time**. \nYou may retrieve this data through the `enrollment-data` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\n\n> ⚠ **Prerequisite:** \nThe merchant must complete the **Merchant Enrollment** process before using this method. \nSee the _Merchant Enrollment_ section for setup details. \n \n> 🔁 **Open Resource:** \nThe **QR Interoperable** operates as an _open resource_, meaning the generated QR can be used multiple times by the same user. \n \n> ⚙️ **Technical Note — Dynamic QR Behavior:** \nDynamic QR codes may be scanned multiple times due to current limitations in the Redeban system. \nThis is **not** an error in our platform. \n \n\n#### Behavior Details\n\n- Redeban does not automatically invalidate a dynamic QR after its first scan.\n \n- As a result, the same QR may generate multiple transaction records.\n \n\n#### Recommendations\n\n- Implement **application-level validation** to detect multiple payments from the same QR code.\n \n- Monitor dynamic QR transactions and confirm status before marking payments as completed.\n \n- Inform end-users to verify the success of a transaction before rescanning.\n \n\n#### Future Considerations\n\n- Redeban is evaluating support for **single-use dynamic QR control**.\n \n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 248,\n \"cellphone\": \"string\",\n \"documentType\": \"string\",\n \"documentNumber\": \"string\",\n \"merchantId\": \"string\"\n}\n\n ```\n\n---\n\n### **Llaves** Dinámicas **Bre-B**\n\nFor this method, the following fields are **required**:\n\n- `cellphone`\n \n- `docNumber`\n \n- `docType`\n \n- `merchantId`\n \n\nYou may retrieve this data through the `enrollment-data` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\n\n> ⚠ **Prerequisite:** \nThe merchant must complete the **Merchant Enrollment** process before using this method. \nSee the _Merchant Enrollment_ section for setup details. \n \n> 🔁 **Open Resource:** \nThe **Llaves Dinamicas Bre-B** operates as an _open resource_, meaning the generated KEY can be used multiple times by the same user. \n \n> ⚙️ **Technical Note — Dynamic Key Behavior:** \nDynamic keys may receive multiple money transfers due to current limitations in the Redeban system. \nThis behavior does not represent an error or malfunction in our platform. \n**Additionally, dynamic keys have a fixed validity period of 5 minutes, and this duration cannot be modified.** \n \n\n#### Behavior Details\n\n- Redeban does not automatically invalidate a dynamic KEY after its first send.\n \n- As a result, the same KEY may generate multiple transaction records.\n \n\n#### Recommendations\n\n- Implement **application-level validation** to detect multiple payments from the same KEY.\n \n- Monitor dynamic KEY transactions and confirm status before marking payments as completed.\n \n- Inform end-users to verify the success of a transaction before rescanning.\n \n\n#### Future Considerations\n\n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 250,\n \"cellphone\": \"string\",\n \"docType\": \"string\",\n \"docNumber\": \"string\",\n \"merchantId\": \"string\"\n}\n\n ```\n\n---\n\n## 📥 Request Body Parameters\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `amount` | number | ✅ | Value of the payment. |\n| `brandId` | number | ❌ | ID of the customer's white label; if one is not available, the default ID 79 is sent. |\n| `expiresIn` | number | ❌ | Time in seconds for the expiration of the resource or payment link. |\n| `paymentMethod` | object | ✅ | Object specifying the payment method and its details. |\n| `paymentMethod.id` | number | ✅ | ID of the selected payment method (see available payment methods). |\n| `reference1` | string | ✅ | Customer identifier, must be between 1 and 30 characters. |\n| `reference2` | object | ❌ | Object for additional information. |\n| `reference2.Commerce` | object | ❌ | Object for information related to the store or commerce. |\n| `reference2.Data` | object | ❌ | Object for information related to the conciliation of the transaction. |\n| `reference2.Label` | object | ❌ | Object to send information to be displayed in the payment summary. |\n| `returnUrl` | string | ❌ | Link that the customer will see when clicking on the back to commerce button. |\n| `showSummary` | boolean | ❌ | Indicates whether the RefácilPay payment summary will be shown or not (false: do not show, true: show). Default: true. |\n| `userMetadata` | object | ✅ | Object containing key details about the user or merchant generating the payment resource. |\n| `userMetadata.identifier` | string | ✅ | Unique identifier of the user or merchant generating the payment resource (max 36 characters). |\n| `userMetadata.ip` | string | ✅ | IP address associated with the user's identifier. Must be a valid IP address. |\n| `userMetadata.urlCommerce` | string | ✅ | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\n| `webhookUrl` | string | ✅ | URL of the client's webhook to receive real-time payment status updates. |",
|
|
130
137
|
"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"
|
|
138
|
+
"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| `250` | Cash-in via **Llaves Bre-B** | 300 |\n\n> ⚠ **Important:** \nThe value provided in the expiresIn field **must be greater than or equal** to the minimum expiration defined for the selected payment method. **This does not apply to dynamic keys, which always expire 5 minutes after creation.** \n \n\n---\n\n## 🧩 Payment Method Details\n\nEach payment method requires a specific object structure within the `\"paymentMethod\"` field.\n\n---\n\n### **Nequi**\n\n``` json\n\"paymentMethod\": {\n \"id\": 130,\n \"cellphone\": \"3105293225\"\n}\n\n ```\n\n---\n\n### **Daviplata**\n\n``` json\n\"paymentMethod\": {\n \"id\": 131,\n \"cellphone\": \"3208385715\"\n}\n\n ```\n\n---\n\n### **PSE**\n\nFor this payment method, depending on the `typePerson` selected, only specific document types are accepted:\n\n- **`typePerson`****:** **`\"0\"`** → corresponds to a **Natural Person** and only accepts the following values for `documentType`:\n \n - `RCN`\n \n - `TI`\n \n - `CC`\n \n - `TE`\n \n - `CE`\n \n - `PA`\n \n - `DIE`\n \n- **`typePerson`****:** **`\"1\"`** → corresponds to a **Legal Person** and only accepts the following value for `documentType`:\n \n - `NIT`\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 133,\n \"documentType\": \"CC\",\n \"typePerson\": \"0\",\n \"bankId\": \"string\",\n \"documentNumber\": \"string\",\n \"name\": \"string\",\n \"cellphone\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\"\n}\n\n ```\n\n---\n\n### **PSE Gateway**\n\nThis payment method enables direct integration with the PSE network for processing online bank payments. \nTo consume this product, it is required to have the following parameters previously configured and associated with your product:\n\n- `entity_code`\n \n- `service_code`\n \n- `company_ciiu`\n \n- `company_name`\n \n\nThese parameters identify your company within the PSE network and are necessary for successful transaction routing and validation.\n\n> 💬 **For more information or to request these credentials, please contact the support team.** \n \n\nThis method follows **the same structure and validation rules** as **PSE**, but must use the following identifier:\n\n``` json\n\"paymentMethod\": {\n \"id\": 262,\n \"documentType\": \"CC\",\n \"typePerson\": \"0\",\n \"bankId\": \"string\",\n \"documentNumber\": \"string\",\n \"name\": \"string\",\n \"cellphone\": \"string\",\n \"address\": \"string\",\n \"email\": \"string\"\n}\n\n ```\n\nThe **PSE integration** relies heavily on the correct configuration of the `showSummary` and `returnUrl` parameters. \nThese parameters control the **user experience** and the **finalization flow** of the payment process.\n\n| Scenario | `showSummary` | `returnUrl` | Flow Description |\n| --- | --- | --- | --- |\n| **1\\. Standard Redirect (Default)** | `true` or not sent | ✅ Present | Displays a transaction summary screen with key payment details and retrieves the final transaction status. After the payment is completed, the user is redirected to the specified `returnUrl`. |\n| **2\\. Without Transaction Summary Screen** | `false` | ✅ Present | Skips the transaction summary screen and redirects the user directly to the `returnUrl`. In this case, the merchant’s system must display the transaction summary on the destination page. |\n\n> ⚠️ **Note:** \nFor **PSE** and **PSE Gateway**, it is **strongly recommended** to use `showSummary: true` along with a valid `returnUrl` to ensure a seamless customer experience and accurate transaction tracking. \n \n> 🔗 **See also:** \n \n\n- [Transaction Summary](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#45e0d76a-fabd-442e-9b17-e2f6b8354ec5)\n \n- [Transaction Status](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#dd3ba9f5-1f10-4109-b59d-6e5aad5e3799)\n \n\n---\n\n### **IPay**\n\n``` json\n\"paymentMethod\": {\n \"id\": 134\n}\n\n ```\n\n---\n\n### **Recaudo Efectivo**\n\n``` json\n\"paymentMethod\": {\n \"id\": 153\n}\n\n ```\n\n---\n\n### **Transfiya Recaudo**\n\n``` json\n\"paymentMethod\": {\n \"id\": 155,\n \"cellphone\": \"3105293225\"\n}\n\n ```\n\n---\n\n### **TPaga**\n\nThis payment method supports an optional parameter called `isQr`, which determines the type of resource returned in the `url` field:\n\n| **Value** | **Description** |\n| --- | --- |\n| `true` | The `url` field returns a link to a **QR code** displaying transaction details. |\n| `false` | The `url` field returns a **deeplink** to open directly in the TPAGA wallet app. |\n\n> 🧠 **Behavior:** \nIf `isQr` is not provided, the default behavior is equivalent to `isQr: false`. \nTransactions can only be completed **from a mobile device**. \nIf the request is made from a desktop or tablet, it is recommended to send `isQr: true` so the user can scan the QR from a mobile device. \n \n\n``` json\n\"paymentMethod\": {\n \"id\": 163,\n \"isQr\": false\n}\n\n ```\n\n---\n\n### **QR Interoperable**\n\nFor this method, the following fields are **optional**:\n\n- `cellphone`\n \n- `documentNumber`\n \n- `documentType`\n \n- `merchantId`\n \n\nThe service can function using only the payment method ID; however, providing these optional fields can **improve response time**. \nYou may retrieve this data through the `enrollment-data` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\n\n> ⚠ **Prerequisite:** \nThe merchant must complete the **Merchant Enrollment** process before using this method. \nSee the _Merchant Enrollment_ section for setup details. \n \n> 🔁 **Open Resource:** \nThe **QR Interoperable** operates as an _open resource_, meaning the generated QR can be used multiple times by the same user. \n \n> ⚙️ **Technical Note — Dynamic QR Behavior:** \nDynamic QR codes may be scanned multiple times due to current limitations in the Redeban system. \nThis is **not** an error in our platform. \n \n\n#### Behavior Details\n\n- Redeban does not automatically invalidate a dynamic QR after its first scan.\n \n- As a result, the same QR may generate multiple transaction records.\n \n\n#### Recommendations\n\n- Implement **application-level validation** to detect multiple payments from the same QR code.\n \n- Monitor dynamic QR transactions and confirm status before marking payments as completed.\n \n- Inform end-users to verify the success of a transaction before rescanning.\n \n\n#### Future Considerations\n\n- Redeban is evaluating support for **single-use dynamic QR control**.\n \n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 248,\n \"cellphone\": \"string\",\n \"documentType\": \"string\",\n \"documentNumber\": \"string\",\n \"merchantId\": \"string\"\n}\n\n ```\n\n---\n\n### **Llaves** Dinámicas **Bre-B**\n\nFor this method, the following fields are **required**:\n\n- `cellphone`\n \n- `docNumber`\n \n- `docType`\n \n- `merchantId`\n \n\nYou may retrieve this data through the `enrollment-data` service in the [Merchant Enrollment](https://documenter.getpostman.com/view/35146358/2sA3QpDEFA#8c9f5a18-a19a-4b8f-baba-cd7501aa29a0) section.\n\n> ⚠ **Prerequisite:** \nThe merchant must complete the **Merchant Enrollment** process before using this method. \nSee the _Merchant Enrollment_ section for setup details. \n \n> 🔁 **Open Resource:** \nThe **Llaves Dinamicas Bre-B** operates as an _open resource_, meaning the generated KEY can be used multiple times by the same user. \n \n> ⚙️ **Technical Note — Dynamic Key Behavior:** \nDynamic keys may receive multiple money transfers due to current limitations in the Redeban system. \nThis behavior does not represent an error or malfunction in our platform. \n**Additionally, dynamic keys have a fixed validity period of 5 minutes, and this duration cannot be modified.** \n \n\n#### Behavior Details\n\n- Redeban does not automatically invalidate a dynamic KEY after its first send.\n \n- As a result, the same KEY may generate multiple transaction records.\n \n\n#### Recommendations\n\n- Implement **application-level validation** to detect multiple payments from the same KEY.\n \n- Monitor dynamic KEY transactions and confirm status before marking payments as completed.\n \n- Inform end-users to verify the success of a transaction before rescanning.\n \n\n#### Future Considerations\n\n- Stay updated with interoperability provider announcements to adjust integrations accordingly.\n \n\n``` json\n\"paymentMethod\": {\n \"id\": 250,\n \"cellphone\": \"string\",\n \"docType\": \"string\",\n \"docNumber\": \"string\",\n \"merchantId\": \"string\"\n}\n\n ```\n\n---\n\n## 📥 Request Body Parameters\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `amount` | number | ✅ | Value of the payment. |\n| `brandId` | number | ❌ | ID of the customer's white label; if one is not available, the default ID 79 is sent. |\n| `expiresIn` | number | ❌ | Time in seconds for the expiration of the resource or payment link. |\n| `paymentMethod` | object | ✅ | Object specifying the payment method and its details. |\n| `paymentMethod.id` | number | ✅ | ID of the selected payment method (see available payment methods). |\n| `reference1` | string | ✅ | Customer identifier, must be between 1 and 30 characters. |\n| `reference2` | object | ❌ | Object for additional information. |\n| `reference2.Commerce` | object | ❌ | Object for information related to the store or commerce. |\n| `reference2.Data` | object | ❌ | Object for information related to the conciliation of the transaction. |\n| `reference2.Label` | object | ❌ | Object to send information to be displayed in the payment summary. |\n| `returnUrl` | string | ❌ | Link that the customer will see when clicking on the back to commerce button. |\n| `showSummary` | boolean | ❌ | Indicates whether the RefácilPay payment summary will be shown or not (false: do not show, true: show). Default: true. |\n| `userMetadata` | object | ✅ | Object containing key details about the user or merchant generating the payment resource. |\n| `userMetadata.identifier` | string | ✅ | Unique identifier of the user or merchant generating the payment resource (max 36 characters). |\n| `userMetadata.ip` | string | ✅ | IP address associated with the user's identifier. Must be a valid IP address. |\n| `userMetadata.urlCommerce` | string | ✅ | URL that identifies the commerce. Must follow valid URL structure with http:// or https:// protocol. Maximum length: 500 characters. |\n| `webhookUrl` | string | ✅ | URL of the client's webhook to receive real-time payment status updates. |\n\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
139
|
},
|
|
133
140
|
{
|
|
134
141
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/cash-out/generate/withdraw-method/token",
|
|
135
142
|
"name": "POST /cash-out/generate/withdraw-method/token - Endpoint Documentation",
|
|
136
143
|
"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
144
|
"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\":
|
|
145
|
+
"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\": 264,\n \"key\": \"@REPRUEBAL7717\"\n },\n \"userMetadata\": {\n \"identifier\": \"1234567890\",\n \"ip\": \"127.0.0.1\",\n \"urlCommerce\": \"https://url-tucomercio.com\"\n }\n}\n```\n\n"
|
|
139
146
|
},
|
|
140
147
|
{
|
|
141
148
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/customer/getbalance",
|
|
142
149
|
"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
|
|
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| `userId (optional)` | number | Integrated unique user identifier |",
|
|
144
151
|
"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
|
|
152
|
+
"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 (optional)` | 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
153
|
},
|
|
147
154
|
{
|
|
148
155
|
"uri": "postman://collection/refacil-pay-api/endpoint/post/payment/transfiya-banks",
|
|
@@ -1 +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,
|
|
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,80EAA80E;KAC11E;IACD;QACE,KAAK,EAAE,yDAAyD;QAChE,MAAM,EAAE,6BAA6B;QACrC,aAAa,EAAE,w2BAAw2B;QACv3B,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,64BAA64B;KACz5B;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,29IAA29I;KACv+I;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,88WAA88W;QAC79W,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,k4YAAk4Y;KAC94Y;IACD;QACE,KAAK,EAAE,4FAA4F;QACnG,MAAM,EAAE,wEAAwE;QAChF,aAAa,EAAE,q+EAAq+E;QACp/E,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,wvGAAwvG;KACpwG;IACD;QACE,KAAK,EAAE,wEAAwE;QAC/E,MAAM,EAAE,oDAAoD;QAC5D,aAAa,EAAE,2eAA2e;QAC1f,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,2xBAA2xB;KACvyB;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"}
|
package/dist/core/tools.d.ts
CHANGED