Consultas

Accounts Query API es un servicio que agrupa toda la información de las cuentas digitales de Pomelo y la disponibiliza para que puedas consultarla.

Te permitirá consultar:

  • La información de las cuentas. Esta información incluye los identificadores bancarios como CVU y alias para Argentina o PIX para Brasil.
  • El balance de cada cuenta.
  • Las actividades de todas tus cuentas.

¿Qué es una actividad?

Es cualquier operación que tuvo la intención de modificar el balance de una cuenta. Es decir:

  • Transacciones concretadas que modificaron el balance de una cuenta.
  • Transacciones que fueron procesadas pero rechazadas. Por ejemplo transacciones de débito que no se pudieron procesar
  • Transacciones no procesadas porque no cumplen con algún requisito. Por ejemplo, intentos de pagos con tarjeta que no

Capacidades de Query API

  • Listar cuentas con sus respectivos balances.
  • Obtener información y balance de una cuenta.
  • Listar actividades de todas las cuentas.
  • Listar actividades de una cuenta.
  • Obtener información de una actividad.

Listar Actividades

El endpoint /core/activities/v1 devuelve un listado paginado de todas las actividades. Puedes usar filtros para especificar que solo se devuelvan las actividades de una cuenta particular.
Parámetros disponibles
Header Parameters
Accept-Languagestring

Lenguajes ordenados según tu preferencia. Especificación técnica

Ejemplo: Accept-Language: en-US;q=1.0,en-*;q=0.5
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Query Parameters
page[number]integer(format: int32)
Número de página
page[size]integer(format: int32)
Tamaño de página
filter[country]string
País de origen de la cuenta.
Ejemplo: ARG
Enum: ARGBRAMEX
filter[account_id]string
ID de la cuenta de la cual quieras obtener el listado de actividades.
Ejemplo: acc-20I5vMjljS3VEyafcX8lA3T3g0c
filter[result]array
Lista de resultados de las transacciones asociadas a las actividades.
Ejemplo: APPROVED,PENDING,REJECTED
Enum: APPROVEDREJECTEDPENDING
filter[type]array
Lista de tipos de transacciones asociadas a las actividades que quieras obtener en el listado.
Ejemplo: CARD_PURCHASE,EXTRACASH
Enum: CARD_PURCHASEEXTRACASHCASHOUT_STORECASHOUT_ATMBANK_TRANSFER_INBANK_TRANSFER_OUTCASHOUTCASHINMANUAL_MOVEMENTCLIENT_PAYMENTPAYMENT_INPAYMENT_OUTP2P_INP2P_OUTBILL_PAYMENT_OUTCASHIN_INVOICEARG_TAX_ADJUSTMENTARG_TAX_REFUND
filter[created_from]string(format: date-time)
Fecha de creación base de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-30T14:47:30.969Z
filter[created_until]string(format: date-time)
Fecha de creación límite de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-31T14:47:30.969Z
filter[updated_from]string(format: date-time)
Fecha de actualización base de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-30T14:47:30.969Z
filter[updated_until]string(format: date-time)
Fecha de actualización límite de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-31T14:47:30.969Z
filter[upsert_from]string(format: date-time)
Fecha de creación o actualización base de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-30T14:47:30.969Z
filter[upsert_until]string(format: date-time)
Fecha de creación o actualización límite de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-31T14:47:30.969Z
sortstring
Ordenamiento que quieras aplicar al listado.
Ejemplo: -created_at,total_amount
Detalle de respuestas
metaobject
dataarrayrequired
¿Te resultó útil esta sección?
GET/core/activities/v1
Ejemplo de respuestas

Obtener Actividades

El endpoint /core/activities/v1/{id} permite obtener información de la actividad que especifiques.
Parámetros disponibles
Header Parameters
Accept-Languagestring

Lenguajes ordenados según tu preferencia. Especificación técnica

Ejemplo: Accept-Language: en-US;q=1.0,en-*;q=0.5
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
idstringrequired
Detalle de respuestas
dataobjectrequired
¿Te resultó útil esta sección?
GET/core/activities/v1/{id}
Ejemplo de respuestas

Listar Cuentas

El endpoint /core/accounts/v1 devuelve un listado paginado de las cuentas digitales junto con sus balances.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Query Parameters
page[number]integer(format: int32)
Número de página
page[size]integer(format: int32)
Tamaño de página
filter[country]string
País de origen de la cuenta.
Ejemplo: ARG
Enum: ARGBRAMEX
filter[status]array
Estado de las cuentas que quieras obtener en el listado.
Ejemplo: ACTIVE,DISABLED,DELETED,FROZEN
Enum: ACTIVEDISABLEDDELETEDFROZEN
filter[owner_type]array
Tipo de cuentas que quieras obtener en el listado.
Ejemplo: USER,CLIENT
Enum: USERCLIENT
filter[user_id]string
ID del usuario del cual quieras obtener sus cuentas.
Ejemplo: usr-20I2tIqG3buTsvHKKORrtY2MkFH
filter[company_id]string
ID de la compañia dueña de la cuenta.
Ejemplo: cmp-20I2tIqG3buTsvHKKORrtY2MkFH
filter[created_from]string(format: date-time)
Fecha de creación base de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-30T14:47:30.969Z
filter[created_until]string(format: date-time)
Fecha de creación límite de las actividades que quieras obtener en el listado.
Ejemplo: 2021-12-31T14:47:30.969Z
sortstring
Ordenamiento que quieras aplicar al listado.
Ejemplo: -created_at,balance
Detalle de respuestas
metaobject
dataarrayrequired
¿Te resultó útil esta sección?
GET/core/accounts/v1
Ejemplo de respuestas

Obtener Cuenta

El endpoint /core/accounts/v1/{id} devuelve la información de la cuenta solicitada, junto con su balance.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
idstring(maxLength: 256, minLength: 0)required
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/core/accounts/v1/{id}
Ejemplo de respuestas