{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9f8551d7-0395-4709-a67a-5d2ca8728ac5","name":"Deel Local Payroll API v1.1","description":"Welcome to the PaySpace API.\n\nOur powerful API allows you to access your employee data in order to utilize in your business environment. You can also push data into PaySpace from third party systems.\n\n> This documentation pertains to v1.1 of the PaySpace API and all URL's references v1.1. \n>  \n> Documentation for version 2.0 can be found [HERE](https://developer.payspace.com/).\nDocumentation for version 1.0 can be found [HERE](https://developer-v1.payspace.com/).  \nFor breaking changes in API versions read [HERE](#6dc9fb4b-f0ee-4f21-a6e6-c0b018f23f6c).  \nOlder version may not be updated \n  \n\nThe respective endpoint's support [ODATA](https://www.odata.org/getting-started/basic-tutorial/) queries which allows you to filter your queries so that only the necessary data is returned.\n\nAn access token is required to access all endpoints and can be obtained using the Authentication endpoint.\n\nExample responses are provided down the right hand side for each endpoint.\n\nIf you would like to have PaySpace notify you of a change on an employee's profile, please refer to our [Webhooks documentation](#28ddfcdd-fe2e-4d29-b966-e063c5e04555).\n\n---\n\n# API Urls\n\n### Testing\n\nWhen testing or developing use the following base urls:\n\n- Authentication: `https://staging-identity.yourhcm.com`\n    \n- API: `https://apistaging.payspace.com`\n    \n\n### Production\n\nFor production use the following base urls:\n\n- Authentication: `https://identity.yourhcm.com`\n    \n- API: `https://api.payspace.com`\n    \n\n---\n\n# Paging data\n\nAll `GET` endpoints by default returns the top **100** records. To get more than a **100** records use a combination of the `$skip` and `$top` query parameters. The maximum value for `$top` is **100**.\n\n> Note that the total record count can be returned in the response body (`@odata.count`) by adding the $count parameter as described in each end point. \n  \n\nExamples:\n\n| Description | `$top` | `$skip` |\n| --- | --- | --- |\n| To get data on page 1 with a page size of 10 | 10 | 0 |\n| To get data on page 2 with a page size of 10 | 10 | 10 |\n| To get data on page 3 with a page size of 100 | 100 | 200 |\n\n---\n\n# Rate Limits\n\nAPI access rate limits are applied at a per-key basis in unit time. Access to the production API using a key is limited to **2000 requests per minute**. In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets. |\n\n| Environment | Rate Limit |\n| --- | --- |\n| Production | 2000 |\n| Staging | 200 |\n\nOnce you hit the rate limit, you will receive a response error with a status code of `429 Too Many Requests`.\n\n---\n\n# Response Errors\n\n###### Not found Error\n\n---\n\nWhen a record could not by found. eg. incorrect key\n\nStatus Code: `404 Not found`\n\nResponse body: _Empty_\n\n###### Unauthorized\n\n---\n\nInvalid or no token\n\nStatus Code: `401 Unauthorized`\n\nResponse body: _Empty_\n\n###### Validation Errors\n\n---\n\nWhen creating or updating a record and not all required values are present or when any other validation fails\n\nStatus Code: `400 Bad Request`\n\nResponse body example:\n\n```\n{\n    \"@odata.context\": \"....\",\n    \"Message\": \"'Quantity' must not be empty.\\r\\n'Description' must not be empty.\",\n    \"Details\": [\n        {\n            \"Message\": \"'Quantity' must not be empty.\"\n        },\n        {\n            \"Message\": \"'Description' must not be empty.\"\n        }\n    ],\n    \"Success\": false\n}\n\n ```\n\n###### Request body JSON Error\n\n---\n\nWhen posting an incorrect JSON payload\n\nStatus Code: `400 Bad Request`\n\nResponse body example:\n\n```\n{\n    \"@odata.context\": \"....\",\n    \"Message\": \"Unexpected end when reading JSON. Path '', line 2, position 0.\",\n    \"Details\": [\n        {\n            \"Message\": \"Unexpected end when reading JSON. Path '', line 2, position 0.\"\n        }\n    ],\n    \"Success\": false\n}\n\n ```\n\n---\n\n# User Agent\n\nInclude the value `payspace.com` as an agent string in the HTTP header `User-Agent` for all requests.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7757277","team":383926,"collectionId":"9f8551d7-0395-4709-a67a-5d2ca8728ac5","publishedId":"2sAY4sij3r","public":true,"publicUrl":"https://developer-v1-1.payspace.com","privateUrl":"https://go.postman.co/documentation/7757277-9f8551d7-0395-4709-a67a-5d2ca8728ac5","customColor":{"top-bar":"B1D8FC","right-sidebar":"B1D8FC","highlight":"00499D"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This documentation is not maintained anymore, please use v2.0"},{"name":"title","value":"Deel Local Payroll API (v1.1)"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b8758753-81bf-4991-be43-e9b664030776/RExQLWxvZ28tZWRpdC5wbmc=","colors":{"top-bar":"B1D8FC","right-sidebar":"B1D8FC","highlight":"00499D"}},{"name":"light","logo":"https://content.pstmn.io/23cacc0b-41e8-4b6e-8bfc-df11dd7b59a7/RExQLWxvZ28tZWRpdC5wbmc=","colors":{"top-bar":"B1D8FC","right-sidebar":"B1D8FC","highlight":"00499D"}}]}},"version":"8.10.1","publishDate":"2025-03-20T06:40:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Deel Local Payroll API (v1.1)","description":"This documentation is not maintained anymore, please use v2.0"},"logos":{"logoLight":"https://content.pstmn.io/23cacc0b-41e8-4b6e-8bfc-df11dd7b59a7/RExQLWxvZ28tZWRpdC5wbmc=","logoDark":"https://content.pstmn.io/b8758753-81bf-4991-be43-e9b664030776/RExQLWxvZ28tZWRpdC5wbmc="}},"statusCode":200},"environments":[{"name":"PRODUCTION","id":"0ae317ed-4d53-42b6-97f2-39644723fefc","owner":"7757277","values":[{"key":"identity-base-url","value":"https://identity.yourhcm.com","enabled":true,"type":"default"},{"key":"api-base-url","value":"https://api.payspace.com","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/03d8eb70dc94fe36e3fe9fbe9c723d3987036666ab0158e26f78bd314cd15cbb","favicon":"https://payspace.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":"PRODUCTION","value":"7757277-0ae317ed-4d53-42b6-97f2-39644723fefc"}],"canonicalUrl":"https://developer-v1-1.payspace.com/view/metadata/2sAY4sij3r"}