{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8bcffa71-4e08-468b-86ff-5198ed50faa2","name":"Spare Open Banking API - UAE Sandbox","description":"Spare Open Banking (Payment Initiation) API documentation for the UAE market.\n\n## Getting started\n\n1. Import the matching environment **Spare Open Banking API - UAE Sandbox**.\n    \n2. Set `baseUrl`, `appIdBase64`, and `apiKeyBase64` (provided by Spare during onboarding).\n    \n3. Run **api -> authentication -> Token -> Create an API token** to obtain a Bearer access token.\n    \n4. Call PIS endpoints under **Open Banking -> pis** using the saved token.\n    \n\n## Authentication\n\nSpare uses App ID + API Key to mint a short-lived JWT:\n\n- `POST /auth/api-keys/sessions` with headers `app-id` (value: `appIdBase64`), `x-api-key` (value: `apiKeyBase64`), and `X-Tenant: UAE`.\n    \n- Use `Authorization: Bearer` on all subsequent PIS calls (`UAE_JWT` environment variable).\n    \n- Signed POST bodies require an `x-signature` header (detached ES256 JWS).\n    \n\nContact Support: [support@tryspare.com](https://mailto:support@tryspare.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"46379988","team":5170313,"collectionId":"8bcffa71-4e08-468b-86ff-5198ed50faa2","publishedId":"2sBY4JwNPg","public":true,"publicUrl":"https://documenter-api.postman.tech/view/46379988/2sBY4JwNPg","privateUrl":"https://go.postman.co/documentation/46379988-8bcffa71-4e08-468b-86ff-5198ed50faa2","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.3","publishDate":"2026-07-07T11:35:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Spare Open Banking API - UAE Sandbox","id":"4f1f4ff3-a3ed-4833-bd8f-7e7dc2ddda5d","owner":"46379988","values":[{"key":"baseUrl","value":"https://api.sandbox.tryspare.ae","enabled":true,"type":"default","description":"Spare UAE sandbox API base URL"},{"key":"tenant","value":"UAE","enabled":true,"type":"default","description":"Tenant for API-key auth (UAE for this collection)"},{"key":"appIdBase64","value":"","enabled":true,"type":"default","description":"app-id header for API-key auth (Base64-encoded App ID provided by Spare)"},{"key":"apiKeyBase64","value":"","enabled":true,"type":"secret","description":"x-api-key header for API-key auth (Base64-encoded API key provided by Spare)"},{"key":"UAE_JWT","value":"","enabled":true,"type":"default","description":"Auto-populated by Create an API token — use as Bearer token on PIS requests"},{"key":"PIS_REFRESH_TOKEN","value":"","enabled":true,"type":"secret","description":"Auto-populated by Create an API token — used by Refresh an API token"},{"key":"x-signature","value":"","enabled":true,"type":"default","description":"Detached ES256 JWS — generate client-side before signed POSTs"},{"key":"providerId","value":"","enabled":true,"type":"default","description":"Bank provider UUID from List providers"},{"key":"providerCode","value":"","enabled":true,"type":"default","description":"Bank provider code (e.g. ADCB)"},{"key":"providerName","value":"","enabled":true,"type":"default","description":"Bank provider display name"},{"key":"paymentRequestRef","value":"","enabled":true,"type":"default","description":"Payment request internalReference from Create payment request"},{"key":"consentId","value":"","enabled":true,"type":"default","description":"Consent ID from Create payment consent"},{"key":"authCode","value":"","enabled":true,"type":"default","description":"Authorization code from bank redirect (?code=)"},{"key":"paymentId","value":"","enabled":true,"type":"default","description":"Payment ID from Write payment"},{"key":"issuer","value":"","enabled":true,"type":"default","description":"Optional issuer (?iss=) from bank redirect"},{"key":"privateKeyPem","value":"","enabled":true,"type":"default"},{"key":"tomorrows_date","value":"","enabled":true,"type":"any"},{"key":"future_date","value":"","enabled":true,"type":"any"},{"key":"year_after_date","value":"","enabled":true,"type":"any"},{"key":"near_year_date","value":"","enabled":true,"type":"any"},{"key":"paymentRequestId","value":"","enabled":true,"type":"default"}],"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/1d5163021d6ec5522d2b987fa12480a058e1bf01f99081d9c12b9a44afd7fe97","favicon":""},"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":"Spare Open Banking API - UAE Sandbox","value":"46379988-4f1f4ff3-a3ed-4833-bd8f-7e7dc2ddda5d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBY4JwNPg"}