{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e6ee203c-54be-44d0-8be3-9550353ed7f1","name":"Andaria APIs | Simplified Embedded","description":"---\n\n# 📄 Simplified Embedded Finance\n\n## Introduction\n\nOur Simplified Embedded API provides a robust suite of services designed to streamline the management of customers, accounts, payment and onboarding processes. The API is organised into six core services:\n\n1. **Requests**: A flexible API for managing requests that offers real-time updates on asynchronous operations.\n    \n2. **Customers**: Easily manage your customers linked to your partner account.\n    \n3. **Accounts**: Effortlessly track user accounts, simplifying the handling of financial transactions within your application.\n    \n4. **Payments**: Execute payments seamlessly, allowing your users to make transactions without leaving your app.\n    \n5. **Notifications**: Receive real-time updates on payments and onboardings.\n    \n6. **Onboarding**: Seamlessly onboard your clients, providing you with a customer reference and a ready-to-use EUR current account.\n    \n\n#### Requests Manager\n\nWhen you send a request to the Andaria API, the system registers it and synchronously assigns a unique request ID. This ID is essential for monitoring the real-time processing status of your request, allowing you to track its journey from initiation to completion and ensuring full visibility throughout the process.\n\nOnce the request is completed, the system sends a callback containing a reference to the specific entity created, such as a payment reference.\n\nA sample callback for a payment might look like this:\n\n``` json\n{      \n\"requestId\": \"2b3fefaf-ac32-4b9e-a266-b0f7ac01fd4c\",\n\"requestTimeStamp\": \"2024-04-22T01:25:04Z\",\n\"status\": \"Andaria.Statuses.Accepted\" \n}\n\n ```\n\nOn success, the reference is returned in the entityId field, whether it’s a payment reference, account reference, etc., depending on your action.\n\n``` json\n{    \n\"entityId\": \"AADO09180000002\",    \n\"entityLocation\": \"https://api-sandbox.andaria.com/payments-services/v2/payments/AADO09180000002\",    \n\"requestId\": \"222febd2-a511-4b56-895f-7fe043aabc70\",\n\"status\": \"Andaria.Statuses.Completed\",\n\"errorDescription\": [] \n}\n\n ```\n\nOn failure, a list of errors is returned in the errorDescription field.\n\n``` json\n{    \n\"entityId\": \"\",   \n\"entityLocation\": \"\",  \n\"requestId\": \"b4dc2d4a-5abd-411f-b537-87df2788f3c7\",\n\"status\": \"Andaria.Statuses.CompletedWithErrors\",\n\"errorDescription\": [ \"Date must be within the next 7 days!\" ]\n}\n\n ```\n\n#### Onboarding Service\n\nOur Onboarding Service allows you to seamlessly onboard your clients. A single onboarding request initiates a two-stage process, after which your client is successfully onboarded. At completion, you will receive a unique customer reference and account reference for their newly created EURO account. For detailed instructions, please refer to our Getting Started page.\n\n#### Customers Service\n\nAfter successfully creating a customer using our Onboarding API, you will receive a unique customer reference via webhook. This reference allows you to query the customer's information.\n\n#### Accounts Service\n\nUpon successfully creating a customer using our Onboarding API, an account will be generated automatically, and you will receive the unique account reference via webhook. If you were onboarded manually, you can utilize the Accounts Service to create a new account.\n\nDuring the account creation process, we will assign account numbers, which you can easily retrieve through the Accounts Service. The account will be ready to receive incoming payments immediately. Additionally, the Accounts Service enables you to make updates, such as renaming or closing accounts, and perform other operations like retrieving statements and checking balances.\n\n#### Payments Service\n\nAndaria offers four types of payments: receiving incoming payments, making outgoing payments, peer-to-peer payments between Andaria customers, and account-to-account transfers.\n\nFor incoming payments, we provide a real-time webhook notification as soon as funds are credited to your customer's account.\n\nOutgoing payments, made by your customers to third parties, are routed through SEPA only.\n\nWhen you initiate a payment request, a request ID is generated as outlined in the \"Requests\" section, and a payment ID will be issued once the payment is completed. You can also subscribe to webhooks via the Notification Services, providing an endpoint to receive real-time updates.\n\n#### Notification Service\n\nOur notification service, powered by webhooks, keeps you informed with real-time updates. You can subscribe to specific events, like onboarding updates, allowing your system to automatically respond to changes in the onboarding process. Notifications are delivered in real time and can be sent through various channels based on your preferences.\n\n#### Responses\n\nAll `POST` or `PATCH` requests are asynchronous endpoints. The responses will return a `202 - Accepted` status. When you poll the Request Manager, you can expect to receive either a `200 OK`, indicating that the request was completed, or a `400 Bad Request`, indicating that the request was not completed due to errors.\n\nAll `GET` requests are synchronous endpoints. The responses will return either an HTTP `200 OK` for successful requests, which includes an Andaria status code within the response payload: `200` when data is returned and `204` when no data is returned. If the request is invalid, the response will be HTTP `417 Expectation Failed`.\n\n#### Response Codes\n\n| HTTP Status | Andaria Status Code | Description |\n| --- | --- | --- |\n| 200 | 200 | Data is returned. |\n| 200 | 204 | No data is returned. |\n| 200 | Statuses.Completed | Async request completed successfully. |\n| 202 | Statuses.Accepted | Async request has been accepted, and processing is in progress. |\n| 400 | Statuses.CompletedWithErrors | Async request is invalid. |\n| 404 | 400 | Not Found |\n| 417 | 417 | Request is invalid. |\n\n---\n# 📄 Get Started\n\n---\n\nTo begin using the Andaria APIs, follow these steps:\n\n- **API Key:** You must include a valid API key in all requests to the API endpoints. To obtain your API key, contact Andaria Support.\n    \n- **Certificate and IP Whitelisting**: You are required to use a valid certificate and ensure your IPs are whitelisted.\n    \n- **HTTPS Requirement**: The API only accepts HTTPS-secured communications. Requests sent via HTTP will receive an HTTP 301 redirect to the corresponding HTTPS resource.\n    \n- **Response Format**: API responses are returned in JSON format. If an error occurs, it will be included in the JSON response under an error key.\n    \n\n**Authentication**: To authenticate requests to the Andaria APIs:\n\n- _API Key Header:_ Include your API key in every request using the Api-Subscription-Key request header. In Postman, you can update the top-level \"Andaria APIs\" Authorization section with your token, which will automatically apply this header to all API requests within the collection.\n    \n- _Additional Requirements:_ Authentication also requires a valid certificate and whitelisted IPs.\n    \n\n**Authentication Error Response**\n\nIf the API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code. If the issue persists, please contact support.\n\n**Bad Gateway Response**\n\nAn HTTP 502 response indicates that the Sandbox environment is currently unavailable. If this issue persists for more than 30 minutes, please contact support.\n\n---\n\n# 📄 Onboarding | Getting Started\n\n## Executive Summary\n\nOnboarding Retail Clients for Simplified Embedded with Andaria involves a streamlined, 2-stage workflow:\n\n1. **Data Capture and Validation:** Collect user data and pass it synchronously through Andaria’s API for initial validation.\n    \n2. **Instant Account Issuance and Activation:** Automatically issue the account and relevant vIBANs/Account Numbers upon successful completion.\n    \n\nThe onboarding service powers this workflow. The initial screens in your UI must capture all required data, which is then sent to Andaria APIs via a single `POST` request. We perform synchronous validation and respond either with validation errors or an **Onboarding Request ID**. This ID allows you to track the progress of the subsequent stages via webhooks until the new client’s account is issued.\n\n---\n\n## Stage 1: Data Capture and Validation\n\nDuring this stage, collect the required client data corresponding to the schema below and submit it via the Onboarding endpoint.\n\n### Onboarding Schema Data Dictionary\n\nBelow is the complete tabular representation of the expected data points, validations, and Enum restrictions extracted from the Onboarding Data Definition.\n\n| **Data Group** | **Data Point Name** | **Request Payload Name** | **Type** | **Validation** | **Mandatory** |\n| --- | --- | --- | --- | --- | --- |\n| Personal Information | First Name | Name | String | Max 50 Chars (Alphabetic) | Y |\n|  | Last Name | Surname | String | Max 50 Chars (Alphabetic) | Y |\n|  | External Reference | External_Ref | String | Unique | N |\n| Contact Information | Phone Number Prefix | Phone_number_prefix | Country Prefix | Max 4 Chars (Numeric) | Y |\n|  | Phone Number | Phone_number | String | Max 20 Chars (Numeric) | Y |\n|  | Email Address | Email | String | Email | Y |\n\n---\n\n### Stage 1 Webhooks\n\n| **Webhook Status** | **Description** |\n| --- | --- |\n| `Validator - Stage 1 - In Progress` | We have received the request for onboarding. The requests is currently being validated in its first stage. |\n| `Validator - Stage 1 - Failed` | Validation has failed on onboarding data . Refer to the error message payload for details. |\n\n### Stage 2: Instant Account Issuance and Activation\n\nOnce Stage 1 is completed successfully, the customer profile is created, resulting in instant account issuance and activation. The exact accounts assigned depend on the Andaria Entity configuration.\n\nUpon Onboarding on the Andaria MT Entity:\n\n- The account reference starts with MT.\n    \n- The account is supplied with an MT vIBAN\n    \n\n### Stage 2 Webhooks\n\n| **Webhook Status** | **Description** |\n| --- | --- |\n| `Creating Customer` | Creating the Customer |\n| `Customer Created - S00000045` | The Customer has been created. Customer Reference: `S0000045` |\n| `Creating Account` | Creating the Accoutn and setting up the IBAN |\n| `Account Created - MT93ANFV30007000000MT0004600001` | The Account has been created.  <br>IBAN: `MT93ANFV30007000000MT0004600001`  <br>Account Reference: `MT0004600001` |\n\n---\n\n# 📄 Payments | Getting Started\n\nOnce retail onboarding is complete, we will provide an Account Reference. This Account Reference represents a EURO current account. The account will be linked to an Andaria IBAN, enabling the end client to perform SEPA transactions(standard SEPA and SEPA Instant).\n\n### SEPA Payments\n\nSEPA (Single Euro Payments Area) payments enable fast, secure euro-denominated transfers and direct debits across 36 europoean countries and territories.\n\n``` json\n{\n    \"paymentType\": \"Andaria.Payments.External\",\n    \"sourceAcc\": \"MT0001000001\",\n    \"amount\": 5,\n    \"date\": \"2026-07-31\",\n    \"benAcc\": \"MT31MALT01100000000000000000123\",\n    \"narrative\": \"SEPA with mandatory fields.\",\n    \"currency\": \"EUR\",\n    \"benName\": \"Andaria SEPA P1\",\n    \"beneficiarySegment\": \"corporate\",\n    \"purposeOfPayment\": \"Technical_Services\",\n    \"purposeOfPaymentCode\": \"Other\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"38399918","team":5586344,"collectionId":"e6ee203c-54be-44d0-8be3-9550353ed7f1","publishedId":"2sBY4ToxY6","public":true,"publicUrl":"https://docs.simplified.andaria.com","privateUrl":"https://go.postman.co/documentation/38399918-e6ee203c-54be-44d0-8be3-9550353ed7f1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.2","publishDate":"2026-07-31T10:03:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Sandbox","id":"133312a4-f6a8-4249-8e28-260c18184828","owner":"38399918","values":[{"key":"Andaria","value":"","enabled":true,"type":"default"},{"key":"YourAPIKey","value":"","enabled":true,"type":"default"},{"key":"SimplifiedPartner","value":"","enabled":true,"type":"default"},{"key":"onboardingRequestId","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/fedba599a04033d2a6f5734d1f661230a61bb3fe21a2930220c289161ffd87e7","favicon":"https://andaria.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Sandbox","value":"38399918-133312a4-f6a8-4249-8e28-260c18184828"}],"canonicalUrl":"https://docs.simplified.andaria.com/view/metadata/2sBY4ToxY6"}