API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

Soláthraíonn APIanna rialaitheacha atá bunaithe ar PSD2 rochtain ar fhaisnéis airgeadais áirithe amhail iarmhéid cuntas bainc agus idirbhearta. Mar sin féin, tá foinsí eile faisnéise saibhris ann nach bhfuil inrochtana trí na APIanna seo. Leathnaíonn API Wealth Reader an fhaisnéis a thairgeann APIanna rialaitheacha trí rochtain fíor-ama a sholáthar ar fhoinsí saibhris breise in aon eintiteas ar fud an domhain. Tá dhá dhoiciméad eile gaolmhara ann a chabhróidh leat API Wealth Reader a chomhtháthú. Is é ceann acu an treoir chomhtháthaithe widget Javascript: https://docs-en.wealthreader.com/ agus is é an ceann eile bailiúchán Postman atá bunaithe ar an doiciméadú seo. An-tábhachtach: Tá an sainmhíniú API seo oiriúnaithe do chliaint a dhéanann comhtháthú trí Widget, mar sin fágadh amach roinnt paraiméadar nach bhfuil riachtanach don chineál seo comhtháthaithe, amhail paraiméadair fíordheimhnithe bainc, mar go n-úsáidfear token.

Core

API lárnach a theastaítear le haghaidh comhtháthaithe caighdeánacha

Faigheann sé sócmhainní airgeadais agus sonraí a gcomhdhéana

Faigheann sé sócmhainní airgeadais agus sonraí a gcomhdhéana lena n-áirítear punanna infheistíochta comhdhéanta de stoic nó cistí, cártaí creidmheasa, árachais agus iasachtaí. Áiríonn sé faisnéis úinéireachta do gach sócmhainn chomh maith le haitheantóirí uathúla a éascaíonn próiseáil sonraí. Is féidir sonraí Mock a fháil. Seiceáil leis an bhfoireann theicniúil conas é seo a dhéanamh.

Request Body schema: application/x-www-form-urlencoded
api_key
string

Aithníonn sé an cliant sa tseirbhís

code
string

Ainm na heintiteas. Tá an liosta iomlán ar fáil le GET

Sampla: caixabank

token
string

Aithníonn sé na dintiúir choimeádta. Tá an sreabhadh trína bhfuarthas an token tuairiscithe sa doiciméad 'Treoir chomhtháthaithe Widget'. Tá na húsáideoirí Mock seo a leanas ar fáil: MOCKDATA, freagra OK; MOCKOTP, freagra le dúshlán OTP; MOCKLOGINKO, freagra le earráid logáil isteach

Sampla: MOCKDATA

product_types
string
Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" "deposits" "leases" "insurances"

Liosta de chineálacha táirgí óna mbeidh faisnéis le fáil. Glacann sé le luachanna iolracha scartha le camóga.

Sampla: accounts,portfolios

only_balances
boolean
Default: false

Léiríonn sé an bhfaightear iarmhéideanna na dtáirgí amháin in ionad na faisnéise uile atá ar fáil. Luach réamhshocraithe: false.

Sampla: false

fetch_transaction_details
boolean
Default: false

Léiríonn sé ar cheart sonraí leathnaithe na n-idirbheart a fháil nuair a thacaíonn ceangaltóir an aonáin leis. TÁBHACHTACH: Má chumasaítear é, ciallaíonn sé go ndéanfar nascleanúint bhreise amháin nó níos mó in aghaidh gach idirbhirt chun an fhaisnéis a chuirtear ar ais a shaibhriú. Méadóidh sé seo go dosheachanta agus go suntasach an t-am rite. Fásann líon na nascleanúintí breise le líon na n-idirbheart. Moltar é a chumasú ach amháin nuair atá tú cinnte go bhfuil leibhéal mionsonraí níos mó ná an ceann a chuirtear ar ais de réir réamhshocraithe ag teastáil. Cuirtear na sonraí a fhaightear isteach san eochair additional_info ar leibhéal gach idirbhirt. Éilíonn úsáid an pharaiméadair seo timpeallacht thiomnaithe.

Sampla: false

date_from
string <date>

Dáta óna n-iarrtar idirbhearta, i bhformáid BBBB-MM-LL. Caithfidh sé a bheith dáta roimh inniu.

Sampla: 2024-01-01

date_to
string <date>

Níl feidhm leis seo ach chun srian a chur ar dhátaí amach anseo do tháirgí loan agus confirming, i bhformáid BBBB-MM-LL. Caithfidh an dáta a bheith níos déanaí ná inniu

Sampla: 2025-12-31

required_products_schema
string

Scéimre táirgí riachtanach. Léiríonn sé na cuntais nó na cártaí óna dteastaíonn sonraí, le cumraíochtaí breise.

Sampla: 

{
  "ACCOUNTS": {
    "0ae4d722b1c82feeafb4b36b2893230444071335": {
      "only_balances": false,
      "add_pdf_from_uuids": [
        "90763109952d4f2ebece8dceca8254078c5384a0"
      ],
      "date_from": "2024-04-03"
    }
  },
  "CARDS": {
    "957e6f63546f3fecacce80192b6f7436496dc057": {}
  }
}
add_pdf_from_uuids
string

Glacann sé le uuid idirbhearta scartha le camóga. Paraiméadar nach dtógtar san áireamh ach amháin má tá product_types ALL nó má chuimsíonn sé accounts. Cuireann sé an doiciméad PDF a bhaineann le gach idirbheart bainc iarrtha.

Sampla: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Roghnaíonn sé cén cainéal seachadta dháfhachtóir le húsáid nuair a d'fhill an API ar chód 2017 nó 20171 (il mhodhanna OTP). Glaoigh arís leis an aitheantas seisiúin céanna leis an bhfreagra sin agus socraigh otp_method ar an teaghrán cruinn sa réimse otp_method de oibiacht i statistics.otpMethods — ní innéacs an tairraing. Fág ar lár ar an gcéad iarratas creidmheasanna; seol tar éis rogha an úsáideora. Is léiriú é an sampla thíos; cóipeáil i gcónaí an teaghrán ó statistics.otpMethods.

Sampla: OTP_SMS ****1234

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4e5f6g7h8i9j0&code=caixabank&token=1234Asdf&product_types=accounts%2Cportfolios&only_balances=false&date_from=2024-01-01&date_to=2025-12-31&required_products_schema=%7B%22ACCOUNTS%22%3A%7B%220ae4d722b1c82feeafb4b36b2893230444071335%22%3A%7B%22only_balances%22%3Afalse%2C%22add_pdf_from_uuids%22%3A%5B%2290763109952d4f2ebece8dceca8254078c5384a0%22%5D%2C%22date_from%22%3A%222024-04-03%22%7D%7D%2C%22CARDS%22%3A%7B%22957e6f63546f3fecacce80192b6f7436496dc057%22%3A%7B%7D%7D%7D&add_pdf_from_uuids=20966426721d0885ef9d4b95535e1d3198936f16%2C8772d6c978d37d7af83094abf380b8b703e94105

Response samples

Content type
application/json
[
  • {
    }
]

Liosta de chineálacha idirbheart

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Iarr ar chomharthaí a bhaineann le api_key

Úsáid an modh seo chun na comharthaí a bhaineann le api_key ar leith a cheistiú. Tá na torthaí roinnte ina leathanaigh: socraíonn limit líon na gcomharthaí in aghaidh an leathanaigh (500 ar a mhéad) agus roghnaíonn page an leathanach a sheoltar ar ais. Tá api_key, method agus limit riachtanach; má tá ceann acu ar iarraidh nó neamhbhailí, freagraíonn an API le HTTP 400 agus cód earráide 2.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string^[a-z0-9]{8}$

api_key chun an cliant a aithint sa tseirbhís

method
required
string
Value: "get"

An oibríocht atá le déanamh. Is é get an t-aon luach a dtacaítear leis.

Sampla: get

limit
required
integer [ 1 .. 500 ]

Líon na gcomharthaí in aghaidh an leathanaigh. Íosmhéid 1, uasmhéid 500.

Sampla: 100

page
integer >= 1
Default: 1

Sonraigh an uimhir leathanaigh a theastaíonn uait a fháil. Tá suas le limit comhartha ar gach leathanach. Mura soláthraítear, is é 1 an luach réamhshocraithe.

Sampla: 1

code
string

Cód eintitis a úsáidtear chun na comharthaí a scagadh. Má fhágtar ar lár é, seoltar ar ais comharthaí na n-eintiteas go léir.

Sampla: bbva

sort_by
string
Default: "created_at"
Enum: "created_at" "accesed_at"

An réimse a úsáidtear chun na torthaí a shórtáil: created_at (dáta cruthaithe) nó accesed_at (dáta rochtana deireanach). Réamhshocrú created_at.

Sampla: created_at

sort_order
string
Default: "DESC"
Enum: "ASC" "DESC"

Treo an tsórtála: ASC (ag dul suas) nó DESC (ag dul síos). Réamhshocrú DESC.

Sampla: DESC

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4&method=get&limit=100&page=1

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    },
  • "pagination": {
    },
  • "statistics": {
    }
}

Cealaigh comhartha

Ceadaíonn an modh seo comhartha atá ann cheana a chealú chun iarratais rochtana API amach anseo a dhícheadú.

Request Body schema: application/x-www-form-urlencoded
required
api_key
string

Aithníonn sé an cliant sa tseirbhís

token
string

Comhartha le cealú.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully revoked."
}

Athshannadh comhartha go api_key difriúil

Ceadaíonn an modh seo comhartha a athshannadh ó api_key amháin go ceann eile.

Request Body schema: application/x-www-form-urlencoded
required
api_key_source
string

api_key óna ndéanfar athshannadh an chomhartha.

api_key_target
string

api_key chuig a ndéanfar athshannadh an chomhartha.

token
string

Comhartha le athshannadh.

Sampla: FRJ0mHlaqZwLzu

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully reassigned."
}

Cuir fearann nua leis

Cuireann sé an nasc idir an fearann a óstálfaidh an widget agus an webhook ceann scríbe. Chun d'fhearainn a chur in eagar nó a thástáil, úsáid https://www.wealthreader.com/clients/

Request Body schema: application/x-www-form-urlencoded
required
method
required
string

Method to execute.

Sampla: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Sampla: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

Sampla: https://desarrollo.cliente.es/hooks/wealthreader

tokenize
required
string
Enum: "1" "0"

Rialaíonn sé an gcuireann an widget sreabhadh comharthaithe ar siúl:

  • 1 - Déanann an t-úsáideoir fíordheimhniú leis an institiúid airgeadais (logáil isteach, toiliú, 2FA más gá) agus seoltar comhartha in-athúsáidte ar ais
  • 0 - Ní dhéantar aon chomharthú. Ní mór luach an chomhartha a fuarthas roimhe seo a chur san iarratas

Sampla: 1

Responses

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=a1b2c3d4e5f6g7h8i9j0&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Liosta de chóid earráide

Liosta de chóid earráide. Tabhair aird speisialta ar an bhfíric nach bhfuil gach cód earráide le cóir mar an gcéanna ó do fheidhmchlár. I gcás earráid pasfhocail mhícheart, níor cheart duit an glao a aththriail leis na paraiméadair chéanna, ach i gcás earráid a léiríonn go bhfuil an t-aonán faoi chothabháil, is féidir leat aththriail a dhéanamh. Iarr seisiún teicniúil lenár bhfoireann chun aon cheisteanna faoi bhainistíocht earráidí a réiteach.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liosta de chóid rabhaidh

Liosta de chóid rabhaidh.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Críochphointí roghnacha nach dteastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid astu ach amháin má thugann Wealth Reader treoir shoiléir.

Faigheann sé liosta na n-eintiteas tacaithe

Faigheann sé liosta na n-eintiteas tacaithe agus an fhaisnéis a theastaíonn chun foirm logáil isteach na heintite a tharraingt.

query Parameters
show_only_tested
integer
Default: 0
Enum: 0 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fíoraigh úinéireacht cuntas bainc trí IBAN

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn sé fíorú an bhfuil duine nádúrtha nó dlíthiúil ina shealbhóir ar chuntas bainc sonrach ag úsáid an IBAN agus sonraí aitheantais an tsealbhóra líomhnaithe. Teastaíonn api_key leis an táirge IBAN_OWNERSHIP údaraithe. Seoltar an chéad iarratas le api_key, iban, document_type, document_number agus holder_name. Má fhilleann an toradh an stádas PENDING, is féidir an fíorú a cheistiú arís trí api_key agus session amháin a sheoladh. Is toradh earráide deiridh é NO_RESPONSE: chun triail eile a bhaint as, caithfear fíorú nua a thosú gan session.

Request Body schema: application/x-www-form-urlencoded
required
One of
api_key
required
string

Identifies the client in the service. It must have the IBAN_OWNERSHIP product authorized.

iban
required
string

IBAN code of the bank account to verify (without spaces)

Sampla: ES4914651234561234567890

document_type
required
string
Enum: "NIF" "NIE" "Pasaporte" "CIF"

Type of identification document

Sampla: NIF

document_number
required
string

Identification document number

Sampla: 12345678Z

holder_name
required
string

Full name of the natural person or company name

Sampla: LUIS GARCIA BAQUERO

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
api_key=a1b2c3d4e5f6g7h8i9j0&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "payload": {
    },
  • "statistics": {
    }
}

Cláraigh úsáideoir nua

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn an críochphointe seo úsáideoir a chlárú ar ardán aistrithe punainne Easytransfer nó ar uirlis tuairiscithe Acumulas, bunaithe ar aitheantóir uathúil.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

Sampla: 12345678A

service
required
string
Enum: "integra" "easy-transfer"

Service associated with the user. Determines the data flow.

Sampla: easy-transfer

email
required
string <email>

User email, used according to service type.

Sampla: sai_banker@singularbank.com

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User registered successfully"
}

Seiceáil stádas cláraithe úsáideora

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Seiceálann sé an bhfuil úsáideoir cláraithe sa chóras Easytransfer nó Acumulas agus tugann sé ar ais an nasc rochtana uathúil don úsáideoir.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key

user_id
required
string

User identification document.

Sampla: 12345678A

Responses

Response samples

Content type
application/json
{}

Cealaigh úsáideoir a cláraíodh roimhe seo

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn an críochphointe seo úsáideoir a dhíchlárú ó sheirbhís ardán Easytransfer nó Acumulas.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

Sampla: 12345678A

service
required
string
Enum: "integra" "easy-transfer" "all"

Service from which to unregister the user. 'all' for all services.

Sampla: easy-transfer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User unregistered successfully"
}

Luchtú nasc baisc

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Tábhachtach: Chun bainistiú próisis bhaisc a úsáid ar thaobh Wealthreader, tá timpeallacht tiomnaithe ag teastáil. Níl an críochphointe seo ar fáil ar api.wealthreader.com. Ceadaíonn na críochphointí atá grúpáilte faoin gclib "batch" naisc bainc iolracha a phróiseáil go hasincronach, murab ionann agus an modh sincronach /entities/. Idéalach chun méideanna móra nasc a phróiseáil agus teorainneacha ama a sheachaint.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

notification_url
required
string <uri>

Webhook URL. A notification is sent to this URL for each individual credential as soon as it completes processing, not only once all connections in the batch are done.

Sampla: https://example.com/webhook/batch-complete

required
Array of objects (batch-connection) non-empty

List of connections to process

Responses

Callbacks

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4e5f6g7h8i9j0",
  • "notification_url": "https://example.com/webhook/batch-complete",
  • "connections": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "total_connections": 5,
  • "estimated_completion_time": "2025-01-20T10:45:00Z"
}

Callback payload samples

Callback
POST: Webhook fired when a credential finishes processing
Content type
application/json
{
  • "batch_id": 10863151,
  • "credential_id": "cred_demo_002",
  • "status": "completed",
  • "timestamp": "2026-05-13T08:02:47+00:00"
}

Faigh staitisticí ginearálta faoi naisc bhaisc

Tá an críochphointe seo roghnach. Faigheann sé staitisticí ginearálta faoi thoradh próiseála na nasc go léir i mbaisc.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "status": "completed",
  • "statistics": {
    }
}

Faigh toradh aonair de nasc sonrach laistigh de bhaisc

Tá an críochphointe seo roghnach. Faigheann sé toradh naisc shonrach ón mbaisc.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

credential_id
required
string

Filter by specific credential_id

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string",
  • "credential_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    },
  • "statistics": {
    }
}

Cards (real time)

Real-time card expense synchronization from the Open Sync mobile app: per-customer employee pre-registration, signed webhooks (card_transaction.created / card_enrollment.confirmed), and REST query / backfill.

Register or rotate the real-time cards webhook

Creates or updates the webhook URL of the customer for the card_transaction.created and card_enrollment.confirmed events (see the cards-webhook-delivery schema for the delivery format and signature). On first setup, or when rotate_secret is true, a new webhook_secret (64 hex characters) is generated and returned once; in any other case webhook_secret comes back as null in the response and cannot be retrieved again. webhook_url must always be https:// and must resolve to a publicly routable host: localhost, private, loopback, link-local (including the cloud metadata address), CGNAT, multicast and reserved addresses are rejected, in any notation (hexadecimal, decimal, octal, short dotted or IPv4-mapped IPv6), and so is a hostname that does not resolve at all. The same check runs again right before every delivery, not only at registration: if the host is repointed at an internal address afterwards (DNS rebinding) the delivery is closed as failed with response_excerpt "blocked_host". Sending null in webhook_url disables webhooks for that customer; omitting the field leaves the stored URL untouched, which is how the secret is rotated without changing the URL.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

webhook_url
string or null

https:// URL that will receive the events, on a publicly routable host that resolves in DNS. null disables webhooks; omitting the field leaves the stored URL unchanged.

Sampla: https://cliente.example.com/webhooks/wealthreader-cards

rotate_secret
boolean
Default: false

When true, generates and returns a new webhook_secret.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Pre-register the email of an employee

Creates an enrollment request in pending status with a short expiry (ttl_minutes, 20 by default, between 1 and 60) for the employee to confirm by opening the mobile app and entering that email (POST /user-sync-validation/, no contract change for the app). It is idempotent: repeating the call for the same (api_key, email) while it is still pending and not expired returns the same request. If the email is already linked to the calling customer, it returns status "active" directly. If it is already linked to a different customer, it returns 409. Rate limit: at most 60 calls to this endpoint per api_key every 60 seconds, counting every attempt and not only the ones that create a row, checked before anything else so the answers that create nothing (200 already active, 409 linked to another customer, 400) cannot be walked as an enumeration oracle. Exceeding it returns 429 with code rate_limited.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

email
required
string <email>

Email of the employee to pre-register.

Sampla: empleado@cliente.com

ttl_minutes
integer [ 1 .. 60 ]
Default: 20

Minutes the request stays valid before expiring.

Responses

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4",
  • "email": "empleado@cliente.com",
  • "ttl_minutes": 20
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Check the status of an enrollment

Read-only status of an enrollment request. It has no side effects on card users, unlike POST /user-sync-validation/, which does confirm. The only write allowed is lazily marking a pending enrollment whose expiry date has already passed as expired.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Sampla: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Sampla: 0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Query / backfill real-time card transactions

Returns the real-time card transactions received for the employees linked to this api_key, ordered by ascending id. Meant both for periodic backfill (poll with date_from/date_to and paginate with since_id) and for one-off queries. This is the same transaction object carried by the card_transaction.created webhook.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Sampla: a1b2c3d4

date_from
string <date>
Example: date_from=2026-07-01

YYYY-MM-DD, on the operation date. Default: today minus 3 days.

Sampla: 2026-07-01

date_to
string <date>
Example: date_to=2026-07-11

YYYY-MM-DD, on the operation date. Default: today.

Sampla: 2026-07-11

email
string <email>
Example: email=empleado@cliente.com

Filters by the email of the employee.

Sampla: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Sampla: 216

limit
integer <= 1000
Default: 500
Example: limit=500

Maximum number of transactions to return (500 by default, 1000 max).

Sampla: 500

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}