{ "uuid": "6bb15688-deaf-4ee4-9718-773bd85bf790", "lastMigration": 29, "name": "Subaccounts API", "endpointPrefix": "accounts", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "a93bd24b-053f-45ee-b5ec-54bf82ef0649", "documentation": "Retrieve list of balance transfers", "method": "get", "endpoint": ":api_key/balance-transfers", "responses": [ { "uuid": "5a89cb59-413f-41ed-9dc4-e3e7d0764ca1", "body": "{\n \"_embedded\": {\n \"balance_transfers\": [\n {\n \"amount\": 123.45,\n \"balance_transfer_id\": \"07b5-46e1-a527-85530e625800\",\n \"created_at\": \"2019-03-02T16:34:49Z\",\n \"from\": \"7c9738e6\",\n \"reference\": \"This gets added to the audit log\",\n \"to\": \"ad6dc56f\"\n }\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "List balance transfers response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3a303dd4-6788-45ba-b4ba-bd32729bcc7a", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dbde93b7-2262-4724-bf54-ef59ae0a2fb3", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "008a5358-8914-4289-8a81-ed2dee1b3941", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "628bd00c-c39b-42cb-a20a-e09184eabf03", "documentation": "Transfer balance", "method": "post", "endpoint": ":api_key/balance-transfers", "responses": [ { "uuid": "a7f99f94-6090-4a0a-bbeb-15c3369e029e", "body": "{\n \"amount\": 123.45,\n \"balance_transfer_id\": \"07b5-46e1-a527-85530e625800\",\n \"created_at\": \"2019-03-02T16:34:49Z\",\n \"from\": \"7c9738e6\",\n \"reference\": \"This gets added to the audit log\",\n \"to\": \"ad6dc56f\"\n}", "latency": 0, "statusCode": 200, "label": "Balance transfer response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35222dc8-9022-4b3c-9ac0-8104f709c7ac", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "60502769-c081-466b-a748-6fad521cc623", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c0abe30d-e192-454c-bc1b-2a3c12bb7734", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e4ad5065-6ecc-423e-9696-99f58d4832b2", "body": "{\n \"detail\": \"The request failed due to validation errors\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"invalid_parameters\": [\n {\n \"name\": \"use_primary_account_balance\",\n \"reason\": \"Should be either 'true' or 'false'\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#validation\"\n}", "latency": 0, "statusCode": 422, "label": "Validation Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ebfc1fdd-ee5b-4f41-b60d-c5597f701577", "documentation": "Retrieve list of credit transfers", "method": "get", "endpoint": ":api_key/credit-transfers", "responses": [ { "uuid": "c7ce1281-5a05-4b45-a9dc-712cef8a0e37", "body": "{\n \"_embedded\": {\n \"credit-transfers\": [\n {\n \"amount\": 123.45,\n \"created_at\": \"2019-03-02T16:34:49Z\",\n \"credit_transfer_id\": \"07b5-46e1-a527-85530e625800\",\n \"from\": \"7c9738e6\",\n \"reference\": \"This gets added to the audit log\",\n \"to\": \"ad6dc56f\"\n }\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "List credit transfers response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "88593637-9e61-4c6c-b967-421d89f31e98", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf79430b-9088-4103-9779-823fdab5eba8", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "68fbb770-8182-4f74-817d-0844e5aba156", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "889ac2b2-2d4a-48f4-850c-02b10b0785b4", "documentation": "Transfer credit", "method": "post", "endpoint": ":api_key/credit-transfers", "responses": [ { "uuid": "2bb9973b-2b35-466c-af8e-43685fc29329", "body": "{\n \"amount\": 123.45,\n \"created_at\": \"2019-03-02T16:34:49Z\",\n \"credit_transfer_id\": \"07b5-46e1-a527-85530e625800\",\n \"from\": \"7c9738e6\",\n \"reference\": \"This gets added to the audit log\",\n \"to\": \"ad6dc56f\"\n}", "latency": 0, "statusCode": 200, "label": "Credit transfer response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f09b5525-84c9-4d04-b2ab-a8d8f73c5171", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf7c2ac1-8e23-40a0-8171-226058047efe", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eac8e4eb-165a-4757-ae32-026ba92383af", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "042e12cc-5164-4deb-bb96-16c57de97de2", "body": "{\n \"detail\": \"The request failed due to validation errors\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"invalid_parameters\": [\n {\n \"name\": \"use_primary_account_balance\",\n \"reason\": \"Should be either 'true' or 'false'\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#validation\"\n}", "latency": 0, "statusCode": 422, "label": "Validation Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bdc5348a-4ab9-4eab-8ec7-626ba8e32eca", "documentation": "Retrieve list of subaccounts", "method": "get", "endpoint": ":api_key/subaccounts", "responses": [ { "uuid": "2779f49e-ea42-41ae-b124-c767e3074476", "body": "{\n \"_embedded\": {\n \"primary_account\": {\n \"api_key\": \"bbe6222f\",\n \"balance\": 100.25,\n \"created_at\": \"2018-03-02T16:34:49Z\",\n \"credit_limit\": -100.25,\n \"name\": \"Subaccount department A\",\n \"primary_account_api_key\": \"acc6111f\",\n \"suspended\": {{faker 'datatype.boolean'}},\n \"use_primary_account_balance\": true\n },\n \"subaccounts\": [\n {\n \"api_key\": \"bbe6222f\",\n \"balance\": 100.25,\n \"created_at\": \"2018-03-02T16:34:49Z\",\n \"credit_limit\": -100.25,\n \"name\": \"Subaccount department A\",\n \"primary_account_api_key\": \"acc6111f\",\n \"suspended\": {{faker 'datatype.boolean'}},\n \"use_primary_account_balance\": true\n }\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Subaccounts response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "706678c1-a104-4e24-84fd-9a12a24745f9", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2bcb1e6f-eb14-4599-b392-99f51079f7ea", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "029fc610-b509-4e11-9de0-94e9ab4138cf", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "23078c43-efac-4fee-b4b6-db24a3c36d07", "documentation": "Create subaccount", "method": "post", "endpoint": ":api_key/subaccounts", "responses": [ { "uuid": "65929b34-80be-4b07-9ccc-bde5819c8957", "body": "{\n \"secret\": \"Password123\"\n}", "latency": 0, "statusCode": 200, "label": "Subaccount response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d7dbf84-c87e-475c-b28a-60c778ca76f3", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d2eed667-9f4c-4360-840b-28b087b6a812", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c8b9c249-b9f2-4ffd-99e0-763a8d0bc252", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e26c32c6-23cf-484c-b317-6c3792d606d6", "body": "{\n \"detail\": \"The request failed due to validation errors\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"invalid_parameters\": [\n {\n \"name\": \"use_primary_account_balance\",\n \"reason\": \"Should be either 'true' or 'false'\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#validation\"\n}", "latency": 0, "statusCode": 422, "label": "Validation Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9380dd48-2996-4295-b980-90e8add7c59d", "documentation": "Retrieve a subaccount", "method": "get", "endpoint": ":api_key/subaccounts/:subaccount_key", "responses": [ { "uuid": "cbeb0069-6033-4b8d-a8f6-294e0d2f4572", "body": "{\n \"api_key\": \"bbe6222f\",\n \"balance\": 100.25,\n \"created_at\": \"2018-03-02T16:34:49Z\",\n \"credit_limit\": -100.25,\n \"name\": \"Subaccount department A\",\n \"primary_account_api_key\": \"acc6111f\",\n \"suspended\": {{faker 'datatype.boolean'}},\n \"use_primary_account_balance\": true\n}", "latency": 0, "statusCode": 200, "label": "Subaccount response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7892d07f-061a-4a4b-9cda-e81bd282fe93", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c94143b-0c0e-4c81-88c5-52128fc1066b", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5aa4ad60-9aed-4cb3-8fa4-e93c02d6880d", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d826b0cb-000e-4582-baba-eba66a6b5afc", "documentation": "Modify a subaccount", "method": "patch", "endpoint": ":api_key/subaccounts/:subaccount_key", "responses": [ { "uuid": "d00c88ef-2189-49bf-bb0e-9e46937dbca5", "body": "{\n \"api_key\": \"bbe6222f\",\n \"balance\": 100.25,\n \"created_at\": \"2018-03-02T16:34:49Z\",\n \"credit_limit\": -100.25,\n \"name\": \"Subaccount department A\",\n \"primary_account_api_key\": \"acc6111f\",\n \"suspended\": {{faker 'datatype.boolean'}},\n \"use_primary_account_balance\": true\n}", "latency": 0, "statusCode": 200, "label": "Subaccount response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d55e9fdd-1dcf-459b-b628-b271fed342eb", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "602bc0bb-7c14-4320-a93c-727767535226", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a271f54-4c87-4cc6-9368-444d4b26a7e8", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "The account ID provided does not exist in our system or you do not have access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b2637aa1-2f1d-4816-a589-b16599e02015", "body": "{\n \"detail\": \"The request failed due to validation errors\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"invalid_parameters\": [\n {\n \"name\": \"use_primary_account_balance\",\n \"reason\": \"Should be either 'true' or 'false'\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#validation\"\n}", "latency": 0, "statusCode": 422, "label": "Validation Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b06985e5-3212-4b1c-9220-284c3530ec51", "documentation": "Transfer number", "method": "post", "endpoint": ":api_key/transfer-number", "responses": [ { "uuid": "dae92aa2-5e1b-4140-9535-9b7bc7bc5d25", "body": "{\n \"country\": \"GB\",\n \"from\": \"7c9738e6\",\n \"number\": \"235077036\",\n \"to\": \"ad6dc56f\"\n}", "latency": 0, "statusCode": 200, "label": "Number transfer response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ac7abfa8-03c5-400b-bf39-aef4617b398a", "body": "{\n \"detail\": \"You did not provide correct credentials\",\n \"instance\": \"798b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid credentials supplied\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credential is missing or invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c517353c-4b90-47d9-83ac-7e3fe51938cc", "body": "{\n \"detail\": \"Account acc6111f is not provisioned to access Subaccount Provisioning API\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Authorisation error\",\n \"type\": \"https://developer.nexmo.com/api-errors#unprovisioned\"\n}", "latency": 0, "statusCode": 403, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f8135b92-1a66-4ee9-aefa-a6169a343e3b", "body": "{\n \"detail\": \"API key 'acc6111f' does not exist, or you do not have access\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "Action is forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f522b2f1-d623-4b4c-9ac8-95482d9c3d01", "body": "{\n \"detail\": \"Could not transfer number {number} from account {from} to {to} - ShortCode is already owned by requesting account\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"title\": \"Transfer Conflict\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#transfer-conflict\"\n}", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e8277564-70c3-4f28-8734-b1e502d102ed", "body": "{\n \"detail\": \"The request failed due to validation errors\",\n \"instance\": \"158b8f199c45014ab7b08bfe9cc1c12c\",\n \"invalid_parameters\": [\n {\n \"name\": \"use_primary_account_balance\",\n \"reason\": \"Should be either 'true' or 'false'\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/subaccounts#validation\"\n}", "latency": 0, "statusCode": 422, "label": "Validation Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "a93bd24b-053f-45ee-b5ec-54bf82ef0649" }, { "type": "route", "uuid": "628bd00c-c39b-42cb-a20a-e09184eabf03" }, { "type": "route", "uuid": "ebfc1fdd-ee5b-4f41-b60d-c5597f701577" }, { "type": "route", "uuid": "889ac2b2-2d4a-48f4-850c-02b10b0785b4" }, { "type": "route", "uuid": "bdc5348a-4ab9-4eab-8ec7-626ba8e32eca" }, { "type": "route", "uuid": "23078c43-efac-4fee-b4b6-db24a3c36d07" }, { "type": "route", "uuid": "9380dd48-2996-4295-b980-90e8add7c59d" }, { "type": "route", "uuid": "d826b0cb-000e-4582-baba-eba66a6b5afc" }, { "type": "route", "uuid": "b06985e5-3212-4b1c-9220-284c3530ec51" } ] }