Get Payment Methods

GET

https://third/v1/providers/paymentmethods

GET

/v1/providers/paymentmethods

$ curl https://third/v1/providers/paymentmethods \
>      -H "x-api-key: {{X_API_KEY}}"

200Get Payment Methods_example

1 {
2   "methods": [
3     {
4       "id": 1,
5       "name": "MobileWallet",
6       "settlement": 600,
7       "minSendAmount": {
8         "currency": "USD",
9         "amount": 2.5
10       },
11       "maxSendAmount": {
12         "currency": "USD",
13         "amount": 1000
14       },
15       "requirements": [
16         {
17           "id": "name",
18           "path": "recipient.name",
19           "type": "text",
20           "validation": "^[a-zA-Z ]{1,50}$"
21         },
22         {
23           "id": "documentType",
24           "path": "recipient.documentType",
25           "type": "option",
26           "validation": "string",
27           "options": [
28             {
29               "code": "CC",
30               "name": "Cédula de Ciudadanía"
31             },
32             {
33               "code": "NIT",
34               "name": "Número de Identificación Tributaria"
35             }
36           ],
37           "valueField": "code"
38         },
39         {
40           "id": "documentNumber",
41           "path": "recipient.documentNumber",
42           "type": "text",
43           "validation": "^[0-9]{5,10}$"
44         },
45         {
46           "id": "phoneNumber",
47           "path": "recipient.phoneNumber",
48           "type": "text",
49           "validation": "[0-9]{7,20}"
50         },
51         {
52           "id": "quoteCurrency",
53           "path": "quoteCurrency",
54           "type": "option",
55           "validation": "string",
56           "options": [
57             {
58               "code": "COP",
59               "name": "Peso colombiano"
60             }
61           ],
62           "valueField": "code"
63         },
64         {
65           "id": "mobileWalletName",
66           "path": "recipient.mobileWallet.name",
67           "type": "option",
68           "validation": "string",
69           "options": [
70             {
71               "code": "179",
72               "name": "Daviplata"
73             },
74             {
75               "code": "197",
76               "name": "Nequi"
77             }
78           ],
79           "valueField": "name"
80         },
81         {
82           "id": "mobileWalletNumber",
83           "path": "recipient.mobileWallet.number",
84           "type": "text",
85           "validation": "string"
86         }
87       ]
88     },
89     {
90       "id": 2,
91       "name": "BankAccount",
92       "settlement": 600,
93       "minSendAmount": {
94         "currency": "USD",
95         "amount": 2.5
96       },
97       "maxSendAmount": {
98         "currency": "USD",
99         "amount": 10
100       },
101       "requirements": [
102         {
103           "id": "name",
104           "path": "recipient.name",
105           "type": "text",
106           "validation": "^[a-zA-Z ]{1,50}$"
107         },
108         {
109           "id": "documentType",
110           "path": "recipient.documentType",
111           "type": "option",
112           "validation": "string",
113           "options": [
114             {
115               "code": "CC",
116               "name": "Cédula de Ciudadanía"
117             },
118             {
119               "code": "NIT",
120               "name": "Número de Identificación Tributaria"
121             }
122           ],
123           "valueField": "code"
124         },
125         {
126           "id": "documentNumber",
127           "path": "recipient.documentNumber",
128           "type": "text",
129           "validation": "^[0-9]{5,10}$"
130         },
131         {
132           "id": "phoneNumber",
133           "path": "recipient.phoneNumber",
134           "type": "text",
135           "validation": "string"
136         },
137         {
138           "id": "quoteCurrency",
139           "path": "quoteCurrency",
140           "type": "option",
141           "validation": "string",
142           "options": [
143             {
144               "code": "COP",
145               "name": "Peso colombiano"
146             }
147           ],
148           "valueField": "code"
149         },
150         {
151           "id": "bankCode",
152           "path": "recipient.bank.code",
153           "type": "option",
154           "validation": "string",
155           "options": [
156             {
157               "code": "177",
158               "name": "Bancolombia"
159             },
160             {
161               "code": "178",
162               "name": "Banco de Bogota"
163             },
164             {
165               "code": "180",
166               "name": "Davivienda"
167             },
168             {
169               "code": "181",
170               "name": "BBVA"
171             },
172             {
173               "code": "182",
174               "name": "Banco de Occidente"
175             },
176             {
177               "code": "183",
178               "name": "Colpatria"
179             },
180             {
181               "code": "184",
182               "name": "Banco popular"
183             },
184             {
185               "code": "185",
186               "name": "Helm Bank"
187             },
188             {
189               "code": "186",
190               "name": "Banco Agrario"
191             },
192             {
193               "code": "187",
194               "name": "BCSC"
195             },
196             {
197               "code": "188",
198               "name": "Corpbanca"
199             },
200             {
201               "code": "189",
202               "name": "Citibank"
203             },
204             {
205               "code": "190",
206               "name": "Banco AV Villas"
207             },
208             {
209               "code": "191",
210               "name": "Banco Procredit Colombia"
211             },
212             {
213               "code": "192",
214               "name": "Banco Pichincha"
215             },
216             {
217               "code": "193",
218               "name": "Bancoomeva"
219             },
220             {
221               "code": "194",
222               "name": "Banco Santander de Negocios Colombia S.A."
223             },
224             {
225               "code": "195",
226               "name": "Banco Falabella"
227             },
228             {
229               "code": "196",
230               "name": "Banco Finandina"
231             },
232             {
233               "code": "198",
234               "name": "Banco Itaú"
235             },
236             {
237               "code": "199",
238               "name": "Banco Itaú Corpbanca"
239             },
240             {
241               "code": "200",
242               "name": "Lulo Bank"
243             },
244             {
245               "code": "201",
246               "name": "Banco Coltefinanciera"
247             },
248             {
249               "code": "202",
250               "name": "Banco Uala"
251             },
252             {
253               "code": "203",
254               "name": "Banco Cooperativo Coopcentral"
255             },
256             {
257               "code": "204",
258               "name": "Rappipay Daviplata"
259             },
260             {
261               "code": "206",
262               "name": "Cooperativa Financiera de Antioquia"
263             },
264             {
265               "code": "207",
266               "name": "Financiera Juriscoop S.A"
267             },
268             {
269               "code": "208",
270               "name": "Confiar"
271             },
272             {
273               "code": "209",
274               "name": "Cootrafa Cooperativa Financiera"
275             },
276             {
277               "code": "210",
278               "name": "Banco GNB Sudameris"
279             },
280             {
281               "code": "211",
282               "name": "Banco Caja Social"
283             },
284             {
285               "code": "226",
286               "name": "SCOTIABANK COLPATRIA"
287             },
288             {
289               "code": "395",
290               "name": "Banco GNB Colom"
291             },
292             {
293               "code": "396",
294               "name": "Coomeva"
295             },
296             {
297               "code": "397",
298               "name": "Coopcentral"
299             },
300             {
301               "code": "398",
302               "name": "Coofinantioquia"
303             },
304             {
305               "code": "399",
306               "name": "Confiar Coopera"
307             },
308             {
309               "code": "400",
310               "name": "Finan Juriscoop"
311             },
312             {
313               "code": "401",
314               "name": "Fiduc Skandia"
315             },
316             {
317               "code": "402",
318               "name": "Direccion Tesor"
319             },
320             {
321               "code": "403",
322               "name": "Bancoldex"
323             },
324             {
325               "code": "404",
326               "name": "Jpmorgan Corpor"
327             },
328             {
329               "code": "405",
330               "name": "BNP Paribas"
331             },
332             {
333               "code": "406",
334               "name": "Banco W S.A"
335             },
336             {
337               "code": "407",
338               "name": "Compensar"
339             },
340             {
341               "code": "409",
342               "name": "nequi"
343             }
344           ],
345           "valueField": "code"
346         },
347         {
348           "id": "bankName",
349           "path": "recipient.bank.name",
350           "type": "text",
351           "validation": "string",
352           "description": "Use the name from the selected bankCode option."
353         },
354         {
355           "id": "accountNumber",
356           "path": "recipient.bank.accountNumber",
357           "type": "text",
358           "validation": "[0-9]{7,20}"
359         },
360         {
361           "id": "accountType",
362           "path": "recipient.bank.accountType",
363           "type": "option",
364           "validation": "string",
365           "options": [
366             {
367               "code": "SAVINGS",
368               "name": "Cuenta de Ahorros"
369             },
370             {
371               "code": "CHECKING",
372               "name": "Cuenta Corriente"
373             }
374           ],
375           "valueField": "code"
376         }
377       ]
378     },
379     {
380       "id": 3,
381       "name": "Breb",
382       "settlement": 200,
383       "minSendAmount": {
384         "currency": "USD",
385         "amount": 2.5
386       },
387       "maxSendAmount": {
388         "currency": "USD",
389         "amount": 1000
390       },
391       "requirements": [
392         {
393           "id": "name",
394           "path": "recipient.name",
395           "type": "text",
396           "validation": "string"
397         },
398         {
399           "id": "documentType",
400           "path": "recipient.documentType",
401           "type": "text",
402           "validation": "string"
403         },
404         {
405           "id": "documentNumber",
406           "path": "recipient.documentNumber",
407           "type": "text",
408           "validation": "string"
409         },
410         {
411           "id": "phoneNumber",
412           "path": "recipient.phoneNumber",
413           "type": "text",
414           "validation": "string"
415         },
416         {
417           "id": "quoteCurrency",
418           "path": "quoteCurrency",
419           "type": "option",
420           "validation": "string",
421           "options": [
422             {
423               "code": "COP",
424               "name": "Peso colombiano"
425             }
426           ],
427           "valueField": "code"
428         },
429         {
430           "id": "keyValue",
431           "path": "recipient.key.value",
432           "type": "text",
433           "validation": "string"
434         }
435       ]
436     }
437   ]
438 }

Returns the list of available payout methods supported by the provider.

Use this endpoint to retrieve all payment methods that can be used as payout destinations for off-ramp transactions (e.g. bank accounts, mobile wallets, Bre-B). The response can be used to dynamically populate payout options in your integration.

Authentication: Bearer token ({{JWT_LOGIN}}) + x-api-key header.

Returns the list of available payout methods supported by the provider. Use this endpoint to retrieve all payment methods that can be used as payout destinations for off-ramp transactions (e.g. bank accounts, mobile wallets, Bre-B). The response can be used to dynamically populate payout options in your integration. **Authentication:** Bearer token (`{{JWT_LOGIN}}`) + `x-api-key` header.

Response headers

x-amzn-RequestIdstringOptional

Access-Control-Allow-OriginstringOptional

x-amz-apigw-idstringOptional

X-Amzn-Trace-IdstringOptional

Response

methodslist of objects

Headers

Response headers

Response