v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Retrieve an Account Statement with Paginated List

get/api/v2.0/accounts/{accountId}/transactionsPaginated

Path parameters

versionstring required

The current version of BaaSiC API

accountIdstring required

Target account identification

Query parameters

transactionIdstring

Transaction unique identifier

referenceIdstring

Unique identifier used as a easier way to retrieve transactions

externalIdstring

Identification created by the partner when create the transaction

type'Credit' | 'Debit'

Filter for getting if is "Credit" or "Debit" transaction. If It's blank will return all transactions. This property is a List

currency'BRL' | 'BRZ' | 'BTC' | 'ETH' | 'USDC' | 'USDT' | 'XRP' | 'ARS' | 'SOL' | 'USD' | 'XLM' | 'ARZ' | 'EUZ' | 'MXZ' | 'COZ' | 'CLZ' | 'PGZ' | 'UYZ' | 'PEZ' | 'EUR' | 'CHF' | 'GBP' | 'LINK' | 'DOT' | 'AAVE' | 'UNI' | 'AVAX' | 'FTM' | 'LUNA' | 'POL' | 'ATOM' | 'BNB' | 'ZAR' | 'BUSD' | 'RNDZ' | 'MXN' | 'COP' | 'OP' | 'ARB' | 'PEPE' | 'SHIB' | 'DOGE' | 'SUI' | 'GALA' | 'SNX' | 'GMX' | 'INJ' | 'LDO' | 'APE' | 'ADA' | 'NEAR' | 'DYN' | 'XTZ' | 'MANA' | 'RDNT' | 'CAKE' | 'DYDX' | 'GLMR' | 'RBTC' | 'CRV' | 'BAL' | 'MKR' | 'TRX' | 'CRO' | 'APTOS' | 'RDOC' | 'ZENIQ' | 'RIF' | 'STBRZ' | 'EURC' | 'MNT' | 'NGN' | 'XAF' | 'XOF' | 'EGP' | 'KES' | 'BWP' | 'GHS' | 'ZMW' | 'GNF' | 'UGX' | 'TON' | 'CLP' | 'CHZ' | 'GNO' | 'DAI' | 'XDAI'

Specify which currencies you would like to filter. This property is a List.

taxIdCountry'ALB' | 'AND' | 'AZE' | 'ARG' | 'AUS' | 'AUT' | 'BHR' | 'ARM' | 'BEL' | 'BOL' | 'BIH' | 'BRA' | 'BGR' | 'BLR' | 'CAN' | 'CHL' | 'CHN' | 'TWN' | 'COL' | 'CRI' | 'HRV' | 'CUB' | 'CYP' | 'CZE' | 'DNK' | 'DOM' | 'ECU' | 'SLV' | 'EST' | 'FRO' | 'FLK' | 'FIN' | 'FRA' | 'GUF' | 'GEO' | 'DEU' | 'GRC' | 'GTM' | 'GUY' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRL' | 'ISR' | 'ITA' | 'JPN' | 'KAZ' | 'KOR' | 'LVA' | 'LTU' | 'LUX' | 'MYS' | 'MLT' | 'MUS' | 'MEX' | 'MCO' | 'MDA' | 'MNE' | 'NLD' | 'NZL' | 'NGA' | 'NOR' | 'PAK' | 'PRY' | 'PER' | 'PHL' | 'POL' | 'PRT' | 'ROU' | 'RUS' | 'SMR' | 'SRB' | 'SVK' | 'SVN' | 'ZAF' | 'ESP' | 'SUR' | 'SWE' | 'CHE' | 'THA' | 'ARE' | 'TUR' | 'UKR' | 'MKD' | 'GBR' | 'USA' | 'URY' | 'UZB' | 'VEN'

The target account owner country. It is obrigatory if param taxId is filled

taxIdstring

Field that uniquely identifies the individual or country. Only numbers accepted, all number should be sent, including leading zeros when applicable.

beginDatestring date

Start date of the searched deposit order

endDatestring date

Final date of the searched deposit order

pageNumberinteger

The current page number

pageSizeinteger

How much transactions should be returned by page

Headers

Authorizationstring required

The personal authentication token obtained by each user from the token authentication endpoint

Response

200

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:amountNet","oasType":"schema","type":"unknown"}

datestring

dateDetailedstring

typestring

transactionIdstring

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:transactionHash","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:wallet","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:counterpartWallet","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:counterpart","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:referenceId","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/transactionsPaginated:get:responses:200:content:application/json:schema:items:properties:blockchain","oasType":"schema","type":"unknown"}

Example response

[
  {
    "amount": {
      "amount": 1700,
      "currency": "BRL"
    },
    "transactionDescription": {
      "name": "Alvaro Silva",
      "taxId": "67223188006",
      "taxIdCountry": "BRA"
    },
    "date": "2019-04-06",
    "dateDetailed": "2019-04-06T03:00:00Z",
    "type": "Credit",
    "transactionId": "76bc2521-0b8f-42ce-96d5-35e4d6aac771"
  }
]