{"info":{"_postman_id":"d2e5c160-268a-481b-9d36-756e87f95d3e","name":"Energylinx Supplier API Documentation","description":"

See below for our supplier-facing Energylinx API endpoints.

Endpoints

For all URLs referenced in this documentation, please substitute {{host}} and {{auth_host}} with the relevant hostnames below, depending on the environment you are accessing (sandbox or production).

Production

{{ auth_host }} = https://auth.prod.energylinx.com

{{ host }} = https://api.prod.energylinx.com

Sandbox

{{ auth_host }} = https://auth.sandbox.energylinx.com

{{ host }} = https://api.sandbox.energylinx.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Endpoints","slug":"endpoints"}],"owner":"13858860","collectionId":"d2e5c160-268a-481b-9d36-756e87f95d3e","publishedId":"TzmCfsDR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-21T14:42:48.000Z"},"item":[{"name":"Switch Status API v1","item":[{"name":"Auth","event":[{"listen":"test","script":{"id":"f2f352d1-1f29-4d66-a7b6-5c89e346c5cc","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"access_token is present\", function () {"," pm.expect(pm.response.text()).to.include(\"access_token\");","});","var response = pm.response.json();","pm.environment.set(\"acl_token\", response.access_token);","console.log(pm.environment);"],"type":"text/javascript"}}],"id":"5d615cb1-ba90-492e-94bd-32adfaa01fed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{base64-encoded-app-client-id:app-client-secret}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{auth_host}}/oauth2/token?grant_type=client_credentials","description":"

Supply your App Client ID and App Client Secret in the request header, in \"Basic Auth\" format. You will then receive a temporary token for use in calling our API's. The token will expire after 60 minutes.

Request and Response:

See sample request and response at right.

\n","urlObject":{"path":["oauth2","token"],"host":["{{auth_host}}"],"query":[{"key":"grant_type","value":"client_credentials"}],"variable":[]}},"response":[{"id":"cb3bc1f0-e170-4d04-a607-d56503ea724e","name":"Auth","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{base64-encoded-app-client-id:app-client-secret}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{auth_host}}/oauth2/token?grant_type=client_credentials","host":["{{auth_host}}"],"path":["oauth2","token"],"query":[{"key":"grant_type","value":"client_credentials"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{{acl_token}}\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"5d615cb1-ba90-492e-94bd-32adfaa01fed"},{"name":"/switch-status/status/{signupId}","event":[{"listen":"prerequest","script":{"id":"8d723536-c781-4116-9995-09c402730ff8","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"ffd6dfed-052e-4d70-a7f0-7f81d3e6da23","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"ef73a46f-03f9-4f99-beea-81e7e8d11a7b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/switch-status/v1/status/4370796","description":"

Supply an energy switch {signupId}, to obtain status information about the electric and/or gas components of that switch.

Request:

Provide a signupId at the end of the URL via GET request. Also supply an Authorization header containing your temporary token.

Response:

On success, returns HTTP code 200 with a payload comprising of the following fields:

data:
- type: will always be \"switch-status\"
- id: signupId
- attributes: details of the switch's status
  - id: signupId
  - supply: holds the status of up to two fuels (elec and/or gas)
    - elec: electricity portion of an elec-only or dual-fuel switch
      - supplierCode: 10-character identifier for supplier customer switched to
      - status: status of the switch
      - statusReason: optional reason for the status change, from a list of predetermined reason strings
      - statusReasonJson: schemaless JSON structure optionally containing some details of recent status changes
      - statusTimestamp: date of last status change
      \n
    - gas: gas portion of a gas-only or dual-fuel switch
      - supplierCode: 10-character identifier for supplier customer switched to
      - status: status of the switch
      - statusReason: optional reason for the status change, from a list of predetermined reason strings
      - statusReasonJson: schemaless JSON structure optionally containing some details of recent status changes
      - statusTimestamp: date of last status change
      \n
    \n
  \n
\n

On error, returns HTTP status code and potentially an error payload:

{\n    \"errors\": [\n        {\n            \"status\": {statusCode},\n            \"detail\": \"Freeform error description text\"\n        }\n    ]\n}\n

","urlObject":{"path":["switch-status","v1","status","4370796"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"20aec63a-52b5-4cac-b147-70e03cce0abc","name":"/switch-status/status/{signupId} - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/switch-status/v1/status/4226704"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"switch-status\",\n \"id\": 4226704,\n \"attributes\": {\n \"id\": 4226704,\n \"supply\": {\n \"elec\": {\n \"supplierCode\": \"SCOTTISH\",\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"business-meter\", \n \"statusReasonJson\": {\n \"notes\": \"some string\"\n },\n \"statusTimestamp\": \"2021-07-09T23:16:38.000Z\"\n },\n \"gas\": {\n \"supplierCode\": \"SCOTTISH\",\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"rejection-other\",\n \"statusReasonJson\": {\n \"2021-07-07 12:43:13\": {\n \"id\": 4226704,\n \"supplierTransactionId\": \"some-id\",\n \"supply\": {\n \"elec\": {\n \"status\": \"registration-rejected\",\n \"statusReason\": \"rejection-other\"\n \"response\": {\n \"transactionId\": \"ELX-4226704\",\n \"response\": {\n \"status\": 400\n \"message\": \"Request failed with status code 400\",\n \"errorDetails\": {\n \"detail\": {\n \"electricity_meter_points\": [\n {\n \"tariff_code\": [\n \"No tariff found matching E-3R-Tariff_3_Year_v3-E.\"\n ]\n }\n ]\n }\n },\n }\n },\n }\n }\n }\n },\n \"statusTimestamp\": \"2021-07-09T23:16:38.000Z\"\n }\n }\n }\n }\n}"},{"id":"58792642-0346-46e4-bec7-041645890f03","name":"/switch-status/status/{signupId} - error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/switch-status/v1/status/123"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"status\": 404,\n \"detail\": \"The switch ID specified in your request is not found in our records.\"\n }\n ]\n}"}],"_postman_id":"ef73a46f-03f9-4f99-beea-81e7e8d11a7b"},{"name":"/switch-status/status","event":[{"listen":"prerequest","script":{"id":"fbdef60a-b77b-4081-8a3e-9268c05b1a45","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"39229f03-b0ff-4fe9-aef6-2ff6bfe4488f","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"807689ac-5d49-4af2-85db-3778cc5c63cc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 4226018,\n \"supply\": {\n \"elec\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"business-meter\",\n \"statusReasonNotes\": \"freeform text\"\n },\n \"gas\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"meter-issue-other\"\n }\n }\n}"},"url":"{{host}}/switch-status/v1/status","description":"

Provide a new status to update a switch to. Status information is supplied for up to two fuels (electricity and gas) per switch signupId.

The PATCH request is validated and then queued for later processing, so you will receive a 202 HTTP code on success.

\"Status\" Validation Rules

This PATCH update endpoint supports changing a switch to any of these statuses:

registration-accepted

cancelled-by-supplier

erroneous-transfer

The following are the only allowable statuses that can precede the three statuses aboove:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Preceding Status	Allowable New Status via PATCH Update Endpoint
`application-exported`	`registration-accepted`
`registration-rejected`	`registration-accepted`
`cancelled-by-supplier`	`registration-accepted`
`erroneous-transfer`	`registration-accepted`
`application-exported`	`cancelled-by-supplier`
`registration-accepted`	`cancelled-by-supplier`
`registration-rejected`	`cancelled-by-supplier`
`erroneous-transfer`	`cancelled-by-supplier`
`supplier-invoiced`	`cancelled-by-supplier`
`commission-paid-by-supplier`	`cancelled-by-supplier`
`cancelled-direct-by-customer`	`cancelled-by-supplier`
`application-exported`	`erroneous-transfer`
`registration-accepted`	`erroneous-transfer`
`registration-rejected`	`erroneous-transfer`
`cancelled-by-supplier`	`erroneous-transfer`
`supplier-invoiced`	`erroneous-transfer`
`commission-paid-by-supplier`	`erroneous-transfer`

\"Status Reason\" Validation Rules

The PATCH endpoint encourages you to provide a statusReason to accompany each status. The statusReason must be chosen from the list below or can be left blank.

Objections raised by previous supplier

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	statusReason value	Description
cancelled-by-supplier	debt	Customer is in debt with previous supplier which has caused previous supplier to raise objection
cancelled-by-supplier	switch-already-in-place	Customer already had a switch in progress causing an automatic objection to be raised
cancelled-by-supplier	empty-occupier-account	Customer moved into property but hasn't signed up with supplier at property causing objection
cancelled-by-supplier	ongoing-meter-reading-dispute	Customer has ongoing meter reading dispute with current supplier causing an objection to be raised
cancelled-by-supplier	objection-other	Other reason for objection being raised or if reason is unknown

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	statusReason value	Description
cancelled-by-supplier	incorrect-mpan	The MPAN provided does not exist
cancelled-by-supplier	incorrect-mprn	The MPRN provided does not exist
cancelled-by-supplier	incorrect-mpas	The MPAN/MPRN provided does not exist
cancelled-by-supplier	mpan-address-mismatch	The MPAN provided does not match the address
cancelled-by-supplier	mprn-address-mismatch	The MPRN provided does not match the address
cancelled-by-supplier	mpas-address-mismatch	The MPAN/MPRN provided does not match the address
cancelled-by-supplier	business-meter	The MPAS provided is for a business meter
cancelled-by-supplier	meter-technical-details-wrong	The Meter Technical Details are unprovided/do not match the tariff in question
cancelled-by-supplier	de-energised-meter	The MPAS provided is for a de-energised meter
cancelled-by-supplier	new-connection	The MPAS provided is for a new connection
cancelled-by-supplier	economy-7-mismatch	Economy 7 MPAS is switching to a non-economy 7 tariff and viceversa
cancelled-by-supplier	related-meter	The customer has a related meter but we have only sent over one MPAN
cancelled-by-supplier	payment-method-mismatch	The customer is PPM but is applying for a credit tariff or vice versa
cancelled-by-supplier	smets1-prepayment-issue	The customer has a smart PPM meter which will switch to MDD upon switch
cancelled-by-supplier	incompatible-meter-type	The customers meter type does not match the tariff selected
cancelled-by-supplier	meter-issue-other	Other reason for meter being rejected

Any other reasons for cancellation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	statusReason value	Description
cancelled-by-supplier	switch-not-in-renewal-period	Customer is outside their renewal period
cancelled-by-supplier	failed-credit-check	Customer has failed credit check
cancelled-by-supplier	tariff-no-longer-available	Tariff requested is no longer available
cancelled-by-supplier	application-not-received	Application file not received
cancelled-by-supplier	already-on-supply-with-us	Property is already on supply with supplier
cancelled-by-supplier	other	Other reason not including objection or meter issue
cancelled-by-supplier	duplicate	Multiple switches for the same property
cancelled-by-supplier	disengaged-switcher	Customer has forgotten setting up the switch
cancelled-by-supplier	customer-no-longer-with-us	Customer switched on Retention Deal is not with same supplier
cancelled-by-supplier	fraud	Customer switch was fraudulent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	statusReason value	Description
cancelled-by-supplier	direct-debit-too-high	Customer cancelled switch as the direct debit was too high
cancelled-by-supplier	meter-issues	Customer cancelled switch due to meter issues they reported
cancelled-by-supplier	already-switched	Customer cancelled switch due to having recently switched themselves
cancelled-by-supplier	exit-fees	Customer cancelled switch due to being liable for exit fees
cancelled-by-supplier	staying-with-current-supplier	Customer cancelled switch as they would like to stay with current supplier
cancelled-by-supplier	unsure-of-new-supplier	Customer cancelled switch due to reservations about the new supplier
cancelled-by-supplier	cancellation-confirmed-by-supplier	Supplier acknowledged customer cancellation
cancelled-by-supplier	customer-cancellation-other	Customer cancelled due to other reason or if reason is unknown

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	statusReason value	Description
erroneous-transfer	fraud	Customer switch was fraudulent. Suspected or confirmed
erroneous-transfer	incorrect-mpan	The MPAN provided does not exist
erroneous-transfer	incorrect-mprn	The MPRN provided does not exist
erroneous-transfer	incorrect-mpas	The MPAN/MPRN provided does not exist
erroneous-transfer	mpan-address-mismatch	The MPAN provided does not match the address
erroneous-transfer	mprn-address-mismatch	The MPRN provided does not match the address
erroneous-transfer	mpas-address-mismatch	The MPAN/MPRN provided does not match the address
erroneous-transfer	customer-did-not-sign-up	Customer did not sign up to switching service
erroneous-transfer	other	System error

Request:

Send a PATCH request payload as shown in example below. Also supply an Authorization header containing your temporary token.

Payload description:

id: signupId
supply
- elec: electricity portion of an elec-only or dual-fuel switch
  - status: new status to update the switch to
  - statusReason: optional reason for the status change; chosen from a list of predetermined reason strings
  - statusReasonNotes: optional free-form details you would like to provide about this status change
  - supplyStartDate: optional. The date in format YYYY-MM-DD. Can be set only with registration-accepted status
  - supplyEndDate: optional. The date in format YYYY-MM-DD. Can be set only with registration-accepted status
  \n
- gas: gas portion of a gas-only or dual-fuel switch
  - status: new status to update the switch to
  - statusReason: optional reason for the status change; chosen from a list of predetermined reason strings
  - statusReasonNotes: optional free-form details you would like to provide about this status change
  \n
\n

Response:

On success, returns empty payload with HTTP code 202.

On error, returns HTTP status code and potentially an error payload:

{\n  \"errors\": [\n    {\n      \"status\": {statusCode},\n      \"detail\": \"Freeform error description text\"\n    }\n  ]\n}\n

","urlObject":{"path":["switch-status","v1","status"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b318427a-db21-4261-9660-621442e4102b","name":"/switch-status/status - validation error","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 4226018,\n \"supply\": {\n \"elec\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"business-meter\",\n \"statusReasonNotes\": \"freeform text\"\n },\n \"gas\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"meter-issue-other\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/switch-status/v1/status - invalid status change"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"status\": 422,\n \"detail\": \"This status code change is invalid (elec: cancelled-by-supplier => cancelled-by-supplier)\"\n }\n ]\n}"},{"id":"d925f345-8ce1-45ad-983d-70d278ee056b","name":"/switch-status/status - success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"{{acl_token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 4226018,\n \"supply\": {\n \"elec\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"business-meter\",\n \"statusReasonNotes\": \"freeform text\"\n },\n \"gas\": {\n \"status\": \"cancelled-by-supplier\",\n \"statusReason\": \"meter-issue-other\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/switch-status/v1/status"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"807689ac-5d49-4af2-85db-3778cc5c63cc"}],"id":"48a73a9f-89fd-4ae9-a68d-14930f5fedb2","description":"

Overview

This concise API provides an energy supplier the ability to get or update the status information of any energy switch submitted to that supplier from Energylinx, using the switch's signupId.

Authentication

We will provide you with an App Client ID and confidential App Client Secret for each of your product brand(s). Authentication is performed by calling an AWS Cognito OAuth endpoint with these credentials. This then provides a temporary token which can be used for subsequent calls to the API.

Rate limit

Currently we have no defined rate limit for number of requests.

HTTP Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Description
200	OK
202	Accepted (PATCH endpoint only: switch status update received, validated, and queued, but not yet acted upon)
401	Not Authorized/Authenticated: authentication process has not succeeded
404	Not Found: switch signupId could not be found in Energylinx database or does not match your supplier brand
422	Unprocessable Entity: validation error
500	Internal Server Error

List of Switch Status Conditions

Below are the potential statuses which can be present per fuel for any Energylinx switch (after the point it has been sent to the supplier).

Switch in Progress

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
`application-exported`	Application was exported to supplier via API or through nightly batch file and switch progress is now in the hands of the supplier. Most suppliers will send a welcome e-mail (or letter) within 5 days of receiving the switch, followed shortly with confirmation of the switch date.
`registration-accepted`	Application is in a pending state between application export and application success or failure; information was provided from the supplier that the switch has progressed, but is not necessarily complete and can still be cancelled; we may not get any further updates from the supplier until `commission-paid-by-supplier`.
`supplier-invoiced`	The supplier has been invoiced. The application is very likely to succeed but can still be cancelled by the supplier. This status can take several months to reach.
`commission-unpayable`	This status covers switches relating to insolvent suppliers, certain other bad debt categories and old switches that did not progress to completion.

Switch Successful

\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
`commission-paid-by-supplier`	The supplier has paid Energylinx and indicated the application has completely succeeded. However, this status can take several months to reach.

Switch Failed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
`cancelled-direct-by-customer`	The customer has contacted us and cancelled the application, and supplier has been informed within 24 hours via nightly batch file. This can only be done during the cooling off period.
`cancelled-by-supplier`	The supplier has cancelled the application.
`registration-rejected`	The supplier has rejected the application; if we can resolve the issue on our side, we will, otherwise the signup will generally later be moved to cancelled-by-supplier.
`erroneous-transfer`	The application was arranged without the customer’s permission (rare).
`duplicate-application`	If the customer makes multiple signups within the same day, their previous un-exported signup(s) are marked as duplicates and cancelled.

API Endpoints

\n","_postman_id":"48a73a9f-89fd-4ae9-a68d-14930f5fedb2"}]}

Endpoints

Production

Sandbox

Request and Response:

Request:

Response:

\"Status\" Validation Rules

\"Status Reason\" Validation Rules

Objections raised by previous supplier

Meter-related cancellations

Any other reasons for cancellation

Any customer cancellation related reasons

Erroneous Transfer related reasons

Request:

Response:

Overview

Authentication

Rate limit

HTTP Response Codes

List of Switch Status Conditions

Switch in Progress

Switch Successful

Switch Failed

API Endpoints