API docs by Redocly

Wealth Reader (8.1.3)

Download OpenAPI specification:

E-mail: [email protected]

Οι κανονιστικές 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

token
string

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

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

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

only_balances
boolean
Default: false

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

date_from
string <date>

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

date_to
string <date>

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

required_products_schema
string

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

add_pdf_from_uuids
string

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

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&code=caixabank&token=MOCKDATA&product_types=accounts%2Cportfolios&date_from=2024-01-01

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. Τα αποτελέσματα επιστρέφονται σε μπλοκ των 500 tokens ανά σελίδα.

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

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

page
number

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

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&page=1

Response samples

Content type
application/json
[
  • {
    }
]

Ανάκληση ενός 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 προς επαναντιστοίχιση.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=12345678&api_key_target=87654321&token=FRJ0mHlaqZwLzu

Response samples

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

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

Προσθέτει τη συσχέτιση μεταξύ του domain που θα φιλοξενήσει το widget και του webhook προορισμού. Για λόγους ασφαλείας, οι λειτουργίες επεξεργασίας και διαγραφής είναι δυνατές μόνο με αίτημα στην υποστήριξη

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

Method to execute.

api_key
required
string

User's API key.

domain
required
string

Domain to add.

url_callback
required
string

URL for callback.

tokenize
required
string

Indicates whether to tokenize or not.

Responses

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=12345678&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 και τα στοιχεία ταυτοποίησης του υποτιθέμενου κατόχου.

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

Identifies the client in the service

iban
required
string

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

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

Type of identification document

document_number
required
string

Identification document number

holder_name
required
string

Full name of the natural person or company name

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    },
  • "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.

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

Service associated with the user. Determines the data flow.

email
required
string <email>

User email, used according to service type.

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.

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.

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

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

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>

URL where notification will be sent when batch processing finishes

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

List of connections to process

Responses

Request samples

Content type
application/json
{
  • "api_key": "12345678",
  • "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"
}

Λήψη γενικών στατιστικών για συνδέσεις 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": {
    }
}