Beneficiarios
Listar beneficiarios
Obtén una lista paginada de los beneficiarios registrados, con filtros opcionales por país, estado, moneda fiat e ID de comercio para encontrar un registro específico.
GET
/
v2
/
payments
Listar beneficiarios
curl --request GET \
--url https://api-test.velafi.com/v2/payments \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/payments")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.currentPage": 123,
"data.size": 123,
"data.total": 123,
"data.record": [
{
"id": 123,
"merchantId": 123,
"country": "<string>",
"fiat": "<string>",
"paymentId": 123,
"paymentMethodName": "<string>",
"realName": "<string>",
"status": 123,
"hasRefundAccount": 123,
"fieldList": {},
"remark": "<string>",
"createTime": 123
}
]
}
}Usa este endpoint para listar todos los beneficiarios registrados en tu cuenta. Filtra los resultados por país, moneda fiat, estado de autenticación o ID de comercio para encontrar rápidamente un beneficiario específico antes de crear una orden de off-ramp. Los resultados están paginados: usa
currentPage y pageSize para navegar por conjuntos de resultados grandes. El campo status de cada registro indica si VelaFi validó la cuenta (1), si todavía la está verificando (2) o si la verificación falló (3).
Endpoint
GET https://api.velafi.com/v2/payments
Usa
https://api-test.velafi.com/v2/payments para pruebas en el sandbox.Parámetros de consulta
string
Nombre completo del país para filtrar los resultados (p. ej.,
"Mexico", "Brazil").integer
Filtra por estado de autenticación:
0 = todos (valor por defecto), 1 = válido, 2 = en autenticación, 3 = autenticación fallida.string
Código de moneda fiat ISO 4217 para filtrar los resultados (p. ej.,
"MXN", "BRL").integer
ID numérico del comercio para filtrar los resultados a un comercio específico.
integer
Número de página que quieres obtener. El valor por defecto es
1.integer
Número de registros por página. El valor por defecto es
10.Campos de la respuesta
integer
Código de estado de la respuesta.
200 indica éxito.string
Mensaje legible de la respuesta.
object
Conjunto de resultados paginado.
Mostrar Campos de data
Mostrar Campos de data
integer
Número de la página devuelta.
integer
Número de registros por página.
integer
Número total de registros de beneficiarios que coinciden, en todas las páginas.
array
Arreglo de objetos de beneficiario.
Mostrar Campos de cada elemento de record
Mostrar Campos de cada elemento de record
integer
ID único del método de pago del usuario (beneficiario). Envíalo como
userPaymentId al crear órdenes de off-ramp.integer
ID del comercio al que pertenece este beneficiario.
string
Nombre completo del país del beneficiario.
string
Código de la moneda fiat asociada a este beneficiario.
integer
ID de configuración del método de pago.
string
Nombre visible del método de pago (p. ej.,
"CHATS", "SPEI").string
Nombre legal del titular de la cuenta.
integer
Estado de autenticación:
1 = válido, 2 = en autenticación, 3 = fallido.integer
1 si este beneficiario está designado como cuenta de reembolso; 0 en caso contrario.object
Mapa clave-valor de los campos de pago guardados para este beneficiario.
string
Nota de texto libre opcional sobre este beneficiario.
integer
Marca de tiempo Unix (milisegundos) en que se creó el beneficiario.
Ejemplo
curl -X GET "https://api.velafi.com/v2/payments?country=Mexico&status=1¤tPage=1&pageSize=10" \
-H "X-BH-TOKEN: YOUR_TOKEN"
{
"code": 200,
"msg": "SUCCESS",
"data": {
"record": [
{
"id": 228,
"merchantId": 67,
"country": "Hong Kong",
"fiat": "USD",
"paymentId": 123,
"paymentMethodName": "CHATS (CPN)",
"realName": "test",
"remark": "11",
"createTime": 0,
"fieldList": {
"Account Owner Type": "Business",
"Account Number": "000000000",
"Bank Name": "Citibank, N.A., Hong Kong Branch",
"Bank Country/Region": "HK",
"Bank Identifier": "CITIHKHX",
"Remarks": "111",
"Street": "1 EXAMPLE STREET",
"City": "Hong Kong",
"State": "HK-HK",
"Country/Region": "HK",
"Postal Code": "00000"
},
"status": 1,
"hasRefundAccount": 0
}
],
"size": 10,
"currentPage": 1,
"total": 1
}
}
⌘I
Listar beneficiarios
curl --request GET \
--url https://api-test.velafi.com/v2/payments \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/payments")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.currentPage": 123,
"data.size": 123,
"data.total": 123,
"data.record": [
{
"id": 123,
"merchantId": 123,
"country": "<string>",
"fiat": "<string>",
"paymentId": 123,
"paymentMethodName": "<string>",
"realName": "<string>",
"status": 123,
"hasRefundAccount": 123,
"fieldList": {},
"remark": "<string>",
"createTime": 123
}
]
}
}