Queries

Accounts Query API is a service that groups all Pomelo digital account information and makes it available for consultation.

You can consult:

  • Account information. This information includes bank identifiers such as CVU and alias for Argentina or PIX for Brazil.
  • The balance for each account.
  • Activities for all your accounts.

What is an activity?

An activity is any operation that was intended to modify the account balance. In other words:

  • Transactions that changed an account balance.
  • Transactions that were processed but rejected. For example, debit transactions that could not be processed due to insufficient balance.
  • Transactions not processed because they do not meet some requirement. For example, card payment attempts that could not be processed because the CVV entered is incorrect.

Query API capabilities

  • List accounts with their respective balances.
  • Get information and balance for an account.
  • List activities for all accounts.
  • List activities for an account.
  • Get information about an activity.

List activities

The core/activities/v1 endpoint returns a paginated list of all activities. You can use filters to specify that only activities for a particular account are returned.
Available parameters
Header Parameters
Accept-Languagestring

Languages sorted according to your preference. Technical specification

Example: Accept-Language: en-US;q=1.0,en-*;q=0.5
Authorizationstringrequired
Example: Bearer {access_token}
Query Parameters
page[number]integer(format: int32)
Page number
page[size]integer(format: int32)
Page size
filter[country]string
Country of origin of the account.
Example: ARG
Enum: ARGBRAMEX
filter[account_id]string
ID of the account for which you want an activities list.
Example: acc-20I5vMjljS3VEyafcX8lA3T3g0c
filter[result]array
List of results of transactions associated with activities.
Example: APPROVED,PENDING,REJECTED
Enum: APPROVEDREJECTEDPENDING
filter[type]array
List of types of transactions associated with the activities you want to obtain in the list.
Example: CARD_PURCHASE,EXTRACASH
Enum: CARD_PURCHASEEXTRACASHCASHOUT_STORECASHOUT_ATMBANK_TRANSFER_INBANK_TRANSFER_OUTCASHOUTCASHINMANUAL_MOVEMENTCLIENT_PAYMENTPAYMENT_INPAYMENT_OUTP2P_INP2P_OUTBILL_PAYMENT_OUTCASHIN_INVOICE
filter[created_from]string(format: date-time)
Base creation date for the activities you want in the list.
Example: 2021-12-30T14:47:30.969Z
filter[created_until]string(format: date-time)
Base creation date for the activities you want in the list.
Example: 2021-12-31T14:47:30.969Z
filter[updated_from]string(format: date-time)
Base update date for the activities you want in the list.
Example: 2021-12-30T14:47:30.969Z
filter[updated_until]string(format: date-time)
End update date for the activities you want in the list.
Example: 2021-12-31T14:47:30.969Z
filter[upsert_from]string(format: date-time)
Creation or base update date for the activities you want in the list.
Example: 2021-12-30T14:47:30.969Z
filter[upsert_until]string(format: date-time)
End creation or update date for the activities you want in the list.
Example: 2021-12-31T14:47:30.969Z
sortstring
Order you wish to apply to the list.
Example: -created_at,total_amount
Response details
metaobject
dataarrayrequired
Was this section helpful to you?
GET/core/activities/v1
Response examples

Get activity

The '/core/activities/v1/{id}' endpoint enables you to get information about any activity specified.
Available parameters
Header Parameters
Accept-Languagestring

Languages sorted according to your preference. Technical specification

Example: Accept-Language: en-US;q=1.0,en-*;q=0.5
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
idstringrequired
Response details
dataobjectrequired
Was this section helpful to you?
GET/core/activities/v1/{id}
Response examples

List Accounts

The '/core/accounts/v1' endpoint returns a paginated listing of digital accounts along with their balances.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Query Parameters
page[number]integer(format: int32)
Page number
page[size]integer(format: int32)
Page size
filter[country]string
Country of origin of the account.
Example: ARG
Enum: ARGBRAMEX
filter[status]array
State of the accounts that you want to obtain in the list.
Example: ACTIVE,DISABLED,DELETED,FROZEN
Enum: ACTIVEDISABLEDDELETEDFROZEN
filter[owner_type]array
Tipo de cuentas que quieras obtener en el listado.
Example: USER,CLIENT
Enum: USERCLIENT
filter[user_id]string
User ID for accounts you wish to view.
Example: usr-20I2tIqG3buTsvHKKORrtY2MkFH
filter[created_from]string(format: date-time)
Base creation date for the activities you want in the list.
Example: 2021-12-30T14:47:30.969Z
filter[created_until]string(format: date-time)
Base creation date for the activities you want in the list.
Example: 2021-12-31T14:47:30.969Z
sortstring
Order you wish to apply to the list.
Example: -created_at,balance
Response details
metaobject
dataarrayrequired
Was this section helpful to you?
GET/core/accounts/v1
Response examples

Get account

The '/core/accounts/v1/{id}' endpoint returns the account information requested, along with the balance.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
idstring(maxLength: 256, minLength: 0)required
Response details
dataobject
Was this section helpful to you?
GET/core/accounts/v1/{id}
Response examples