{"_id":"5bc63663e56ccb00448e4da3","project":"550f74bb6fc8130d0038aad3","version":{"_id":"550f75de61d9d30d00af9e01","__v":17,"project":"550f74bb6fc8130d0038aad3","forked_from":"550f74bb6fc8130d0038aad6","createdAt":"2015-03-23T02:09:34.221Z","releaseDate":"2015-03-23T02:09:34.221Z","categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5be5d13ff1d319002baca9ce","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-11-09T18:26:07.698Z","from_sync":false,"order":0,"slug":"getting-started","title":"Wyre API"},"user":"54eb883f4f94620d00789aaa","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-16T19:05:07.585Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":true,"order":5,"body":"Successful requests will be a HTTP 200 response after any successful call. The body of successful requests depend on the endpoint. \n\nWhenever a problem occurs, Wyre will respond to the client using a `4xx` or `5xx` status code. In this case, the body of the response will be an exception object which describes the problem. All\n`4xx` errors indicate a problem with your request, while `5xx` indicate an internal problem with our systems.\n\nAll exceptions come equipped with an exception ID (the `exceptionId` field). In the case you require\nsupport, please supply this ID to assist our support team in locating your issue.\n\nThe following table describes the fields on the returned JSON exception:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`exceptionId`\",\n    \"2-0\": \"`errorCode`\",\n    \"3-0\": \"`message`\",\n    \"4-0\": \"`language`\",\n    \"5-0\": \"`transient`\",\n    \"h-1\": \"Description\",\n    \"h-0\": \"Field\",\n    \"0-1\": \"A unique identifier for this exception. This is very helpful when contacting support\",\n    \"2-1\": \"A more granular specification than `type`\",\n    \"1-0\": \"`type`\",\n    \"4-1\": \"Indicates the language of the exception message\",\n    \"3-1\": \"A human-friendly description of the problem\",\n    \"1-1\": \"The category of the exception. See [below](doc:errors#error-types)\",\n    \"5-1\": \"In rare cases, an exception may signal `true` here to indicate a transient problem. This means the request can be safely re-attempted\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\nAn example JSON representation of an `AccessDeniedException`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"language\\\": \\\"en\\\",\\n    \\\"exceptionId\\\": \\\"TLFN89\\\",\\n    \\\"errorCode\\\": \\\"accessDenied.invalidSession\\\",\\n    \\\"message\\\": \\\"Invalid Session\\\",\\n    \\\"type\\\": \\\"AccessDeniedException\\\",\\n    \\\"transient\\\": false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Error Types\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ValidationException`\",\n    \"8-0\": \"`UnknownException`\",\n    \"1-0\": \"`InsufficientFundsException`\",\n    \"2-0\": \"`AccessDeniedException`\",\n    \"7-0\": \"`RateLimitException`\",\n    \"3-0\": \"`TransferException`\",\n    \"6-0\": \"`NotFoundException`\",\n    \"5-0\": \"`CustomerSupportException`\",\n    \"4-0\": \"`MFARequiredException`\",\n    \"h-0\": \"Exception Type\",\n    \"h-2\": \"HTTP Status Code\",\n    \"0-2\": \"400\",\n    \"1-2\": \"400\",\n    \"2-2\": \"401\",\n    \"3-2\": \"400\",\n    \"4-2\": \"400\",\n    \"h-1\": \"Details\",\n    \"5-2\": \"400\",\n    \"6-2\": \"404\",\n    \"7-2\": \"429\",\n    \"8-2\": \"500\",\n    \"0-1\": \"The action failed due to problems with the request.\",\n    \"8-1\": \"A problem with our services internally. This should rarely happen\",\n    \"1-1\": \"You requested the use of more funds in the specified currency than were available\",\n    \"7-1\": \"Your requests have exceeded your usage restrictions. Please contact us if you need this increased\",\n    \"3-1\": \"There was a problem completing your transfer request\",\n    \"6-1\": \"You referenced something that could not be located\",\n    \"5-1\": \"Please contact us at support:::at:::sendwyre.com to resolve this!\",\n    \"4-1\": \"An MFA action is required to complete the request. In general you should not get this exception while using API keys\",\n    \"2-1\": \"You lack sufficient privilege to perform the requested action\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","excerpt":"","slug":"errors","type":"basic","title":"Errors"}
Successful requests will be a HTTP 200 response after any successful call. The body of successful requests depend on the endpoint. Whenever a problem occurs, Wyre will respond to the client using a `4xx` or `5xx` status code. In this case, the body of the response will be an exception object which describes the problem. All `4xx` errors indicate a problem with your request, while `5xx` indicate an internal problem with our systems. All exceptions come equipped with an exception ID (the `exceptionId` field). In the case you require support, please supply this ID to assist our support team in locating your issue. The following table describes the fields on the returned JSON exception: [block:parameters] { "data": { "0-0": "`exceptionId`", "2-0": "`errorCode`", "3-0": "`message`", "4-0": "`language`", "5-0": "`transient`", "h-1": "Description", "h-0": "Field", "0-1": "A unique identifier for this exception. This is very helpful when contacting support", "2-1": "A more granular specification than `type`", "1-0": "`type`", "4-1": "Indicates the language of the exception message", "3-1": "A human-friendly description of the problem", "1-1": "The category of the exception. See [below](doc:errors#error-types)", "5-1": "In rare cases, an exception may signal `true` here to indicate a transient problem. This means the request can be safely re-attempted" }, "cols": 2, "rows": 6 } [/block] An example JSON representation of an `AccessDeniedException`: [block:code] { "codes": [ { "code": "{\n \"language\": \"en\",\n \"exceptionId\": \"TLFN89\",\n \"errorCode\": \"accessDenied.invalidSession\",\n \"message\": \"Invalid Session\",\n \"type\": \"AccessDeniedException\",\n \"transient\": false\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Error Types" } [/block] [block:parameters] { "data": { "0-0": "`ValidationException`", "8-0": "`UnknownException`", "1-0": "`InsufficientFundsException`", "2-0": "`AccessDeniedException`", "7-0": "`RateLimitException`", "3-0": "`TransferException`", "6-0": "`NotFoundException`", "5-0": "`CustomerSupportException`", "4-0": "`MFARequiredException`", "h-0": "Exception Type", "h-2": "HTTP Status Code", "0-2": "400", "1-2": "400", "2-2": "401", "3-2": "400", "4-2": "400", "h-1": "Details", "5-2": "400", "6-2": "404", "7-2": "429", "8-2": "500", "0-1": "The action failed due to problems with the request.", "8-1": "A problem with our services internally. This should rarely happen", "1-1": "You requested the use of more funds in the specified currency than were available", "7-1": "Your requests have exceeded your usage restrictions. Please contact us if you need this increased", "3-1": "There was a problem completing your transfer request", "6-1": "You referenced something that could not be located", "5-1": "Please contact us at support@sendwyre.com to resolve this!", "4-1": "An MFA action is required to complete the request. In general you should not get this exception while using API keys", "2-1": "You lack sufficient privilege to perform the requested action" }, "cols": 3, "rows": 9 } [/block]