API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

Οι κανονιστικές API που βασίζονται στο PSD2 παρέχουν πρόσβαση σε ορισμένες χρηματοοικονομικές πληροφορίες όπως υπόλοιπα τραπεζικών λογαριασμών και συναλλαγές. Ωστόσο, υπάρχουν άλλες πηγές πληροφοριών πλούτου που δεν είναι προσβάσιμες μέσω αυτών των API. Το API Wealth Reader επεκτείνει τις πληροφορίες που προσφέρονται από τις κανονιστικές API παρέχοντας πρόσβαση σε πραγματικό χρόνο σε πρόσθετες πηγές πλούτου σε οποιαδήποτε οντότητα παγκοσμίως. Υπάρχουν δύο άλλα σχετικά έγγραφα που θα σας βοηθήσουν να ενσωματώσετε το API Wealth Reader. Το ένα είναι ο οδηγός ενσωμάτωσης του widget Javascript: https://docs-en.wealthreader.com/ και το άλλο είναι μια συλλογή Postman βασισμένη σε αυτή την τεκμηρίωση. Πολύ σημαντικό: Αυτός ο ορισμός API είναι προσαρμοσμένος για πελάτες που ενσωματώνουν μέσω Widget, επομένως έχουν παραλειφθεί ορισμένες παράμετροι που δεν είναι απαραίτητες για αυτόν τον τύπο ενσωμάτωσης, όπως οι παράμετροι ελέγχου ταυτότητας τράπεζας, καθώς θα χρησιμοποιηθεί ένα token.

Core

Κύριο API που απαιτείται για τυπικές ενσωματώσεις

Ανάκτηση χρηματοοικονομικών περιουσιακών στοιχείων και λεπτομερών στοιχείων της σύνθεσής τους

Ανάκτηση χρηματοοικονομικών περιουσιακών στοιχείων και λεπτομερών στοιχείων της σύνθεσής τους συμπεριλαμβανομένων χαρτοφυλακίων επενδύσεων αποτελούμενων από μετοχές ή αμοιβαία κεφάλαια, πιστωτικές κάρτες, ασφάλειες και δάνεια. Περιλαμβάνει πληροφορίες ιδιοκτησίας για κάθε περιουσιακό στοιχείο καθώς και μοναδικούς αναγνωριστικούς κωδικούς που διευκολύνουν την επεξεργασία δεδομένων. Είναι δυνατή η λήψη δεδομένων Mock. Ελέγξτε με την τεχνική ομάδα πώς να το κάνετε.

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

Αναγνωρίζει τον πελάτη στην υπηρεσία

code
string

Όνομα της οντότητας. Η πλήρης λίστα είναι διαθέσιμη με GET

Παράδειγμα: caixabank

token
string

Αναγνωρίζει τα φυλασσόμενα διαπιστευτήρια. Η ροή μέσω της οποίας αποκτήθηκε το token περιγράφεται στο έγγραφο 'Οδηγός ενσωμάτωσης Widget'. Οι ακόλουθοι χρήστες Mock είναι διαθέσιμοι: MOCKDATA, απόκριση OK; MOCKOTP, απόκριση με πρόκληση OTP; MOCKLOGINKO, απόκριση με σφάλμα σύνδεσης

Παράδειγμα: MOCKDATA

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

Λίστα τύπων προϊόντων από τους οποίους θα ανακτηθούν πληροφορίες. Δέχεται πολλαπλές τιμές διαχωρισμένες με κόμματα.

Παράδειγμα: accounts,portfolios

only_balances
boolean
Default: false

Υποδεικνύει εάν θα ληφθούν μόνο τα υπόλοιπα των προϊόντων αντί όλων των διαθέσιμων πληροφοριών. Προεπιλεγμένη τιμή: false.

Παράδειγμα: false

fetch_transaction_details
boolean
Default: false

Υποδεικνύει εάν θα πρέπει να ληφθούν εκτεταμένες λεπτομέρειες των συναλλαγών όταν το υποστηρίζει ο σύνδεσμος της οντότητας. ΣΗΜΑΝΤΙΚΟ: Η ενεργοποίησή του συνεπάγεται την εκτέλεση μίας ή περισσότερων πρόσθετων πλοηγήσεων ανά συναλλαγή για τον εμπλουτισμό των επιστρεφόμενων πληροφοριών. Αυτό θα αυξήσει αναπόφευκτα και σημαντικά τον χρόνο εκτέλεσης. Ο αριθμός των πρόσθετων πλοηγήσεων αυξάνεται με τον όγκο των συναλλαγών. Συνιστάται να το ενεργοποιείτε μόνο όταν είστε βέβαιοι ότι απαιτείται επίπεδο λεπτομέρειας πέραν αυτού που επιστρέφεται από προεπιλογή. Οι λεπτομέρειες που λαμβάνονται εισάγονται στο κλειδί additional_info σε επίπεδο κάθε συναλλαγής. Η χρήση αυτής της παραμέτρου απαιτεί αποκλειστικό περιβάλλον.

Παράδειγμα: false

date_from
string <date>

Ημερομηνία από την οποία ζητούνται οι συναλλαγές, σε μορφή ΕΕΕΕ-ΜΜ-ΗΗ. Πρέπει να είναι ημερομηνία πριν από σήμερα.

Παράδειγμα: 2024-01-01

date_to
string <date>

Αυτό ισχύει μόνο για περιορισμό κατά μελλοντικές ημερομηνίες για προϊόντα loan και confirming, σε μορφή ΕΕΕΕ-ΜΜ-ΗΗ. Η ημερομηνία πρέπει να είναι μεταγενέστερη του σήμερα

Παράδειγμα: 2025-12-31

required_products_schema
string

Σχήμα απαιτούμενων προϊόντων. Υποδεικνύει τους λογαριασμούς ή τις κάρτες από τις οποίες επιθυμούνται δεδομένα, με πρόσθετες ρυθμίσεις.

Παράδειγμα: 

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

Δέχεται uuid συναλλαγών χωρισμένα με κόμματα. Παράμετρος που λαμβάνεται υπόψη μόνο εάν product_types είναι ALL ή περιλαμβάνει accounts. Προσθέτει το έγγραφο PDF που σχετίζεται με καθεμία από τις αιτούμενες τραπεζικές συναλλαγές.

Παράδειγμα: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Επιλέγει ποιο κανάλι παράδοσης δεύτερου παράγοντα να χρησιμοποιηθεί όταν το API επέστρεψε κωδικό 2017 ή 20171 (πολλαπλές μέθοδοι OTP). Επαναλάβετε την κλήση με το ίδιο αναγνωριστικό συνεδρίας εκείνης της απόκρισης και ορίστε το otp_method στην ακριβή συμβολοσειρά του πεδίου otp_method ενός αντικειμένου στο statistics.otpMethods — όχι το ευρετήριο πίνακα. Παραλείψτε στην πρώτη αίτηση με διαπιστευτήρια· στείλτε μετά την επιλογή του χρήστη. Το παρακάτω παράδειγμα είναι ενδεικτικό· αντιγράψτε πάντα τη συμβολοσειρά από το statistics.otpMethods.

Παράδειγμα: 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
[
  • {
    }
]

Λίστα τύπων συναλλαγών

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Ερώτημα για tokens που σχετίζονται με ένα api_key

Χρησιμοποιήστε αυτή τη μέθοδο για να αναζητήσετε τα tokens που συνδέονται με ένα συγκεκριμένο api_key. Τα αποτελέσματα επιστρέφονται σε σελίδες: το limit ορίζει τον αριθμό των tokens ανά σελίδα (έως 500) και το page επιλέγει τη σελίδα που επιστρέφεται. Τα api_key, method και limit είναι υποχρεωτικά· αν κάποιο λείπει ή δεν είναι έγκυρο, το API απαντά με HTTP 400 και κωδικό σφάλματος 2.

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

api_key για την αναγνώριση του πελάτη στην υπηρεσία

method
required
string
Value: "get"

Λειτουργία προς εκτέλεση. Η μόνη υποστηριζόμενη τιμή είναι get.

Παράδειγμα: get

limit
required
integer [ 1 .. 500 ]

Αριθμός tokens ανά σελίδα. Ελάχιστο 1, μέγιστο 500.

Παράδειγμα: 100

page
integer >= 1
Default: 1

Προσδιορίστε τον αριθμό σελίδας που θέλετε να ανακτήσετε. Κάθε σελίδα περιέχει έως limit tokens. Αν δεν παρέχεται, η προεπιλεγμένη τιμή είναι 1.

Παράδειγμα: 1

code
string

Κωδικός οντότητας για το φιλτράρισμα των tokens. Αν παραλειφθεί, επιστρέφονται τα tokens όλων των οντοτήτων.

Παράδειγμα: bbva

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

Πεδίο ταξινόμησης των αποτελεσμάτων: created_at (ημερομηνία δημιουργίας) ή accesed_at (ημερομηνία τελευταίας πρόσβασης). Προεπιλογή created_at.

Παράδειγμα: created_at

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

Κατεύθυνση ταξινόμησης: ASC (αύξουσα) ή DESC (φθίνουσα). Προεπιλογή DESC.

Παράδειγμα: 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": {
    }
}

Ανάκληση ενός token

Αυτή η μέθοδος επιτρέπει την ανάκληση ενός υπάρχοντος token για την απενεργοποίηση μελλοντικών αιτημάτων πρόσβασης στο API.

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

Αναγνωρίζει τον πελάτη στην υπηρεσία

token
string

Token προς ανάκληση.

Responses

Response samples

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

Επαναντιστοίχιση ενός token σε διαφορετικό api_key

Αυτή η μέθοδος επιτρέπει την επαναντιστοίχιση ενός token από ένα api_key σε άλλο.

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

api_key από το οποίο θα γίνει επαναντιστοίχιση του token.

api_key_target
string

api_key στο οποίο θα γίνει επαναντιστοίχιση του token.

token
string

Token προς επαναντιστοίχιση.

Παράδειγμα: 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."
}

Προσθήκη νέου domain

Προσθέτει τη συσχέτιση μεταξύ του domain που θα φιλοξενήσει το widget και του webhook προορισμού. Για επεξεργασία ή δοκιμή των domains σας, χρησιμοποιήστε https://www.wealthreader.com/clients/

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

Method to execute.

Παράδειγμα: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Παράδειγμα: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

Παράδειγμα: https://desarrollo.cliente.es/hooks/wealthreader

tokenize
required
string
Enum: "1" "0"

Ελέγχει αν το widget ξεκινά ροή tokenization:

  • 1 - Ο χρήστης αυθεντικοποιείται στο χρηματοπιστωτικό ίδρυμα (login, συναίνεση, 2FA αν χρειάζεται) και επιστρέφεται ένα επαναχρησιμοποιήσιμο token
  • 0 - Δεν εκτελείται tokenization. Η τιμή του προηγουμένως αποκτηθέντος token πρέπει να συμπεριληφθεί στο αίτημα

Παράδειγμα: 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"
}

Λίστα κωδικών σφάλματος

Λίστα κωδικών σφάλματος. Δώστε ιδιαίτερη προσοχή στο γεγονός ότι δεν πρέπει όλοι οι κωδικοί σφάλματος να αντιμετωπίζονται με τον ίδιο τρόπο από την εφαρμογή σας. Για ένα σφάλμα λανθασμένου κωδικού πρόσβασης, δεν πρέπει να επαναλάβετε την κλήση με τις ίδιες παραμέτρους, αλλά για ένα σφάλμα που υποδεικνύει ότι η οντότητα είναι υπό συντήρηση, μπορείτε να δοκιμάσετε ξανά. Ζητήστε μια τεχνική συνεδρία με την ομάδα μας για να επιλύσετε τυχόν απορίες σχετικά με τη διαχείριση σφαλμάτων.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Λίστα κωδικών προειδοποίησης

Λίστα κωδικών προειδοποίησης.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Προαιρετικά endpoints που δεν απαιτούνται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από την Wealth Reader.

Ανάκτηση της λίστας υποστηριζόμενων οντοτήτων

Ανάκτηση της λίστας υποστηριζόμενων οντοτήτων και των πληροφοριών που απαιτούνται για τη σχεδίαση της φόρμας σύνδεσης της οντότητας.

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
[
  • {
    }
]

Επαλήθευση ιδιοκτησίας τραπεζικού λογαριασμού μέσω IBAN

Αυτό το endpoint είναι προαιρετικό και δεν απαιτείται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από τη Wealth Reader. Επιτρέπει την επαλήθευση του εάν ένα φυσικό ή νομικό πρόσωπο είναι κάτοχος συγκεκριμένου τραπεζικού λογαριασμού χρησιμοποιώντας το IBAN και τα στοιχεία ταυτοποίησης του υποτιθέμενου κατόχου. Απαιτεί api_key με εγκεκριμένο το προϊόν IBAN_OWNERSHIP. Το αρχικό αίτημα αποστέλλεται με api_key, iban, document_type, document_number και holder_name. Εάν το αποτέλεσμα επιστρέψει κατάσταση PENDING, η επαλήθευση μπορεί να αναζητηθεί ξανά στέλνοντας μόνο api_key και session. Το NO_RESPONSE είναι τελικό αποτέλεσμα σφάλματος: για επανάληψη πρέπει να ξεκινήσει νέα επαλήθευση χωρίς 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)

Παράδειγμα: ES4914651234561234567890

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

Type of identification document

Παράδειγμα: NIF

document_number
required
string

Identification document number

Παράδειγμα: 12345678Z

holder_name
required
string

Full name of the natural person or company name

Παράδειγμα: 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": {
    }
}

Εγγραφή νέου χρήστη

Αυτό το endpoint είναι προαιρετικό και δεν απαιτείται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από τη Wealth Reader. Αυτό το endpoint επιτρέπει την εγγραφή χρήστη είτε στην πλατφόρμα μεταφοράς χαρτοφυλακίου Easytransfer είτε στο εργαλείο αναφορών 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.

Παράδειγμα: 12345678A

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

Service associated with the user. Determines the data flow.

Παράδειγμα: easy-transfer

email
required
string <email>

User email, used according to service type.

Παράδειγμα: sai_banker@singularbank.com

Responses

Response samples

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

Έλεγχος κατάστασης εγγραφής χρήστη

Αυτό το endpoint είναι προαιρετικό και δεν απαιτείται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από τη Wealth Reader. Ελέγχει εάν ένας χρήστης είναι εγγεγραμμένος στο σύστημα Easytransfer ή Acumulas και επιστρέφει τον μοναδικό σύνδεσμο πρόσβασης για τον χρήστη.

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

Authentication key

user_id
required
string

User identification document.

Παράδειγμα: 12345678A

Responses

Response samples

Content type
application/json
{}

Ανάκληση προηγουμένως εγγεγραμμένου χρήστη

Αυτό το endpoint είναι προαιρετικό και δεν απαιτείται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από τη Wealth Reader. Αυτό το endpoint επιτρέπει την απεγγραφή ενός χρήστη από την υπηρεσία της πλατφόρμας Easytransfer ή 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.

Παράδειγμα: 12345678A

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

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

Παράδειγμα: easy-transfer

Responses

Response samples

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

Φόρτωση συνδέσεων batch

Αυτό το endpoint είναι προαιρετικό και δεν απαιτείται για τυπικές ενσωματώσεις. Χρησιμοποιήστε μόνο εάν ρητά οδηγηθεί από τη Wealth Reader. Σημαντικό: Για να χρησιμοποιήσετε τη διαχείριση διεργασιών batch από την πλευρά του Wealthreader, απαιτείται αποκλειστικό περιβάλλον. Αυτό το endpoint δεν είναι διαθέσιμο στο api.wealthreader.com. Τα endpoints που ομαδοποιούνται κάτω από την ετικέτα "batch" επιτρέπουν την ασύγχρονη επεξεργασία πολλαπλών τραπεζικών συνδέσεων, σε αντίθεση με τη σύγχρονη μέθοδο /entities/. Ιδανικό για επεξεργασία μεγάλων όγκων συνδέσεων και αποφυγή timeouts.

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.

Παράδειγμα: 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"
}

Λήψη γενικών στατιστικών για συνδέσεις batch

Αυτό το endpoint είναι προαιρετικό. Ανακτά γενικά στατιστικά για το αποτέλεσμα επεξεργασίας όλων των συνδέσεων σε ένα batch.

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": {
    }
}

Λήψη μεμονωμένου αποτελέσματος μιας συγκεκριμένης σύνδεσης εντός batch

Αυτό το endpoint είναι προαιρετικό. Ανακτά το αποτέλεσμα μιας συγκεκριμένης σύνδεσης από το batch.

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.

Παράδειγμα: 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.

Παράδειγμα: 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.

Παράδειγμα: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Παράδειγμα: 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.

Παράδειγμα: a1b2c3d4

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

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

Παράδειγμα: 2026-07-01

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

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

Παράδειγμα: 2026-07-11

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

Filters by the email of the employee.

Παράδειγμα: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Παράδειγμα: 216

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

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

Παράδειγμα: 500

Responses

Response samples

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