{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a7d67ae9-bf0a-468c-8856-e3267845029b","name":"Ebury Transactional API","description":"# Getting Started\n\nThe Ebury API has been designed for ease of use, but there are a number of things that need to happen or you need to know before you can start developing against it.\n\n## Onboarding\n\nIn order to use the API your company needs to be one of the following:\n\n- To be an existing Ebury customer with access to Ebury Online;\n    \n- To be on-boarded as an Ebury customer with access to Ebury Online: Currently this is an out-of-band process that needs to be completed by the Ebury sales team.\n    \n\n**Live on-boarding functionality is planned for a future phase of the API.**\n\n## Credentials\n\nWith an active Ebury Online account you need a few details to call the API:\n\n- An API key so your application can access the API, together with a client secret that is used in the Authentication workflow;\n    \n- An access token which you will get by implementing the Authentication workflow;\n    \n- A client account identifier that links a user to a given account and needs to be passed to the Authentication workflow;\n    \n- You'll need to supply a redirect URL, which will be used during the Authentication workflow.\n    \n\n**Our developer portal is still being built so we'll share the API key and client secret with you offline. In the future registration and management of this information will be completely self-service.**\n\n## Environments\n\nThe following is a list of environments available when developing against or using our API:\n\n##### Environment Endpoints\n\n| URL | Purpose |\n| --- | --- |\n| `https://sandbox.ebury.io` | Sandbox API endpoint |\n| `https://auth-sandbox.ebury.io` | Sandbox authentication endpoint |\n| `https://api.ebury.io` | Production API endpoint |\n| `https://auth.ebury.io` | Production authentication endpoint |\n\n## API Description\n\nWhilst each subject area is documented below they are also supported by an individual Swagger specification document.\n\n## Rate limiting\n\nRate limiting of the Ebury API is primarily on a per-client basis — or more accurately described, per user API key. If you receive a response with a status code of `429 Too Many Requests`, it means that you have been rate limited for sending too many requests, and should wait before sending further requests.\n\n## Error Handling\n\nThe Ebury API tries to honour HTTP return codes relevant to error that's being conveyed. However, 4xx HTTP return codes are also used as a \"blanket\" with more information to be found (in general) in the [response body](#error-message) e.g., a `409` will indicate an issue with the data sent that can be rectified: you should consult this message to help you take corrective action.\n\n##### HTTP Response Codes\n\n| Response code | Meaning |\n| --- | --- |\n| `200 OK` | Request completed successfully. See individual endpoints for details of response content. |\n| `201 Created` | Request completed successfully, and a resource was created. See individual endpoints for details of response content. |\n| `202 Accepted` | Request completed successfully, but not completely processed. See individual endpoints for details of response content. |\n| `400 Bad Request` | The request could not be processed due to some error e.g., formatting, parameter or schema validation. See [error message](#error-message) for details of response content. |\n| `401 Unauthorized` | Access denied due to authentication failure |\n| `403 Forbidden` | Could not complete action due to data constraints. See [error message](#error-message) for details of response content. |\n| `404 Not Found` | The requested resource could not be found. See individual endpoints for details of how to identify resources. |\n| `409 Conflict` | Request could not be completed. See [error message](#error-message) for details of response content. |\n| `429 Too Many Requests` | You have exceeded the rate limit for API key. See [rate limiting](#rate-limiting) for details. |\n| `502 Bad Gateway` | Internal error. See [error message](#error-message) for details of response content. |\n| `503 Service Unavailable` | Internal error. See [error message](#error-message) for details of response content. |\n| `504 Gateway Timeout` | Internal timeout. See [error message](#error-message) for details of response content. |\n\n### Error Message\n\n``` json\n{\n    \"code\": \"string\",\n    \"message\": \"string\",\n    \"details\": \"string\"\n}\n\n ```\n\nError messages are presented as JSON objects.\n\n##### Error Message Fields\n\n| Field | Description |\n| --- | --- |\n| `code` | A short code for the error |\n| `message` | The error message |\n| `details` | Error details |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7111015","team":12570,"collectionId":"a7d67ae9-bf0a-468c-8856-e3267845029b","publishedId":"2sA3JNbfxe","public":true,"publicUrl":"https://postman.ebury.io","privateUrl":"https://go.postman.co/documentation/7111015-a7d67ae9-bf0a-468c-8856-e3267845029b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.4","publishDate":"2024-05-13T09:49:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://ebury.io/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"}],"canonicalUrl":"https://postman.ebury.io/view/metadata/2sA3JNbfxe"}