# Octane REST API ## Docs - Getting Started [API Access & Authentication](https://octane-api.apidog.io/doc-399363.md): - Getting Started [API Rate Limiting](https://octane-api.apidog.io/doc-783919.md): - Integration Guides [Payment Integration](https://octane-api.apidog.io/doc-435011.md): - Integration Guides [CDR Integration](https://octane-api.apidog.io/doc-463602.md): - Integration Guides [Test Environment Data Sets](https://octane-api.apidog.io/doc-463605.md): - Integration Guides > Mobile Flows [Activate Postpaid Mobile (New MSN - Physical SIM)](https://octane-api.apidog.io/doc-481285.md): - Integration Guides > Mobile Flows [Activate Postpaid (Port MSN - Physical SIM)](https://octane-api.apidog.io/doc-481322.md): - Integration Guides > Mobile Flows [Activate Postpaid Mobile (New MSN - eSIM)](https://octane-api.apidog.io/doc-481327.md): - Integration Guides > Mobile Flows [Activate Postpaid (Port MSN - eSIM)](https://octane-api.apidog.io/doc-481382.md): - Integration Guides > Mobile Flows [Reset eSIM Profile](https://octane-api.apidog.io/doc-481383.md): - Integration Guides > Mobile Flows [Mobile Data Pool Flow](https://octane-api.apidog.io/doc-483076.md): - Integration Guides > ConnectYou Flows [ConnectYou Business SIP Trunk Activate Flow](https://octane-api.apidog.io/doc-484661.md): - Integration Guides > ConnectYou Flows [ConnectYou Business SIP Trunk Reactivate Direct Indials Flow](https://octane-api.apidog.io/doc-484681.md): - Integration Guides > ConnectYou Flows [ConnectYou Unite Calling Activate Flow](https://octane-api.apidog.io/doc-525865.md): - Integration Guides > NBN Flows [NBN Activate Flow](https://octane-api.apidog.io/doc-504808.md): - Integration Guides > NBN Flows [NBN Plan Change Flow](https://octane-api.apidog.io/doc-504823.md): - Integration Guides > NBN Flows [NBN Termination Flow](https://octane-api.apidog.io/doc-504825.md): - Integration Guides > NBN Flows [NBN Reschedule Appointment Flow](https://octane-api.apidog.io/doc-505595.md): - Integration Guides > NBN Flows [NBN Withdraw Order Flow](https://octane-api.apidog.io/doc-505599.md): - Integration Guides > NBN Flows [Run NBN Diagnostic Test Flow](https://octane-api.apidog.io/doc-505602.md): - Integration Guides > NBN Flows [Run NBN Service Health Check Flow](https://octane-api.apidog.io/doc-505604.md): - API Documentation (Legacy APIs) [WSDL Summary](https://octane-api.apidog.io/doc-463533.md): ## API Docs - API Documentation > Customer [Add Customer](https://octane-api.apidog.io/api-5018476.md): This API will be used to create a new Customer. - API Documentation > Customer [Get Customer Detail](https://octane-api.apidog.io/api-5018475.md): This API will be used to retrieve the full customer detail about a specific customer. - API Documentation > Customer [List Customers](https://octane-api.apidog.io/api-4781540.md): This API will be used to retrieve a list of customers currently owned by a Service Provider Group. The list of customers is retrieved based on the Group calling the API. - API Documentation > Customer [Update Customer](https://octane-api.apidog.io/api-5020900.md): This API can be used to update the details of an existing Customer Account. - API Documentation > Customer [Set Customer Direct Debit](https://octane-api.apidog.io/api-9226863.md): This API can be used to set the direct debit details of an existing Customer Account. - API Documentation > Customer [Send Welcome Email](https://octane-api.apidog.io/api-9231084.md): This API can be used to resend the welcome email of an existing Octane customer with a Customer Portal Account. - API Documentation > Payment Method [List Payment Methods](https://octane-api.apidog.io/api-5032549.md): This API will be used to retrieve a list of currently configured Payment Methods for a specified Customer - API Documentation > Payment Method [Add Payment Method](https://octane-api.apidog.io/api-5032582.md): This API will be used to add a new payment method to a Customer account by supplying a single-use token. - API Documentation > Payment Method [Update Payment Method](https://octane-api.apidog.io/api-5032617.md): This API will be used to update an existing payment method on a Customer account. User can update Expiry Date and Cardholder Name for CC Accounts, or Account Name for a DD account. - API Documentation > Payment Method [Delete Payment Method](https://octane-api.apidog.io/api-5032618.md): This API will be used to delete an existing payment method from a Customer account. - API Documentation > Transaction [List Transactions](https://octane-api.apidog.io/api-5033334.md): This API will be used to list transactions added against a customer account, which can include Payments, Refunds, and Misc Credit/Debits - API Documentation > Transaction [Make Payment](https://octane-api.apidog.io/api-5033269.md): This API will be used to make payment by supplying a single-use token, paymentId, or customer’s default payment method. - API Documentation > Transaction [Add Misc Adjustment](https://octane-api.apidog.io/api-5033335.md): This API will be used to list transactions added against a customer account, which can include Payments, Refunds, and Misc Credit/Debits - API Documentation > Transaction [List Bounced Transactions](https://octane-api.apidog.io/api-5492030.md): This API will be used to list transactions added against a customer account, which can include Payments, Refunds, and Misc Credit/Debits - API Documentation > Service [List Services for a Customer](https://octane-api.apidog.io/api-5100796.md): List all services that belong to a customer account - API Documentation > Service [Get Service Detail by LineSeqNo](https://octane-api.apidog.io/api-6984647.md): Get detail for a specific service based on Line Sequence Number. - API Documentation > Mobile > Notification [Get Notification Settings](https://octane-api.apidog.io/api-17920320.md): - API Documentation > Mobile > Notification [Update Notification Settings](https://octane-api.apidog.io/api-18180261.md): - API Documentation > Mobile [Get Data Pool](https://octane-api.apidog.io/api-6274993.md): Get the details of a data pool for a given custno and lineseqno OR a service number. - API Documentation > Mobile [Update Data Limit](https://octane-api.apidog.io/api-6282038.md): Update data limits for consumers within a pool for a given custno and lineseqno - API Documentation > Mobile [Transfer Services to Another Pool](https://octane-api.apidog.io/api-6282771.md): Transfer consumers from one pool to another - API Documentation > Mobile [Disconnect a Data Pool](https://octane-api.apidog.io/api-6283963.md): Disconnect the pool - API Documentation > Mobile [Get eSIM Details](https://octane-api.apidog.io/api-6284473.md): Get the details of a SIM resource (Either Physical or eSIM) or retrieve the QR code to download eSIM profile - API Documentation > Mobile [Manage eSIM](https://octane-api.apidog.io/api-6285895.md): API to reset eSIM profile status. - API Documentation > Address [Search for an Address](https://octane-api.apidog.io/api-5035169.md): This API can be used to retrieve an NBN or Opticomm Location ID based on an Address Search - API Documentation > Address [Search for an Address V2](https://octane-api.apidog.io/api-14390881.md): This API can be used to retrieve an NBN or Opticomm Location ID based on an Address Search from ABB - API Documentation > Service Qualification [Perform Service Qualification Check](https://octane-api.apidog.io/api-5037724.md): Perform a Service Qualification check on a Location ID to determine what products are available. - API Documentation > Order > v1 [Create Order (NBN Activation)](https://octane-api.apidog.io/api-5327814.md): This API can be used for creating all orders. This specific definition will explain how to create an order to complete an NBN Activation specifically - API Documentation > Order > v1 [Create Order (NBN Modification)](https://octane-api.apidog.io/api-6875354.md): This API can be used for creating all orders. This specific definition will explain how to create an order to complete an NBN Activation specifically - API Documentation > Order > v1 [Create Order (NBN Disconnection)](https://octane-api.apidog.io/api-6875370.md): This API can be used for creating all orders. This specific definition will explain how to create an order to complete an NBN Activation specifically - API Documentation > Order > v1 [Cancel (NBN Activation) Order ](https://octane-api.apidog.io/api-6875391.md): Submit a Request to withdraw an NBN Activation order. This will cancel a booked appointment and withdraw the order. - API Documentation > Order > v1 [Get Order Detail (NBN)](https://octane-api.apidog.io/api-5328628.md): Get full detail for an order - API Documentation > Order > v1 [List Orders (NBN)](https://octane-api.apidog.io/api-5100837.md): List all orders for a group - API Documentation > Enquiry [Create Enquiry (NBN Diagnostic Test / Service Health Check)](https://octane-api.apidog.io/api-5100161.md): Creates an Enquiry against a specified Service to request specific details about a Service. This API can currently be used to submit a Diagnostic Test for an NBN service, or run a Service Health Check. Once an Enquiry is created, you will be able to pull the Enquiry details via the GET method once the applicable tests have been completed. - API Documentation > Enquiry [Get Enquiry Detail](https://octane-api.apidog.io/api-5100171.md): Retrieves the full detail of an Enquiry showing the result of a Diagnostic Test or Service Health Check - API Documentation > Enquiry [List Enquiries](https://octane-api.apidog.io/api-5100456.md): Retrieves the full detail of an Enquiry showing the result of a Diagnostic Test or Service Health Check - API Documentation > Appointment [Query Appointment Timeslots](https://octane-api.apidog.io/api-5100534.md): Get available timeslots for an in-flight NBN order - API Documentation > Appointment [Book Appointment](https://octane-api.apidog.io/api-5100554.md): Book a new appointment or reschedule an existing one for an NBN order - API Documentation > NBN [Get Available Diagnostic Tests](https://octane-api.apidog.io/api-5100168.md): Retrieves a list of Diagnostic Tests that can be run for a Service - API Documentation (Legacy APIs) > API Guide > Account Charges [Add a Recurring Charge](https://octane-api.apidog.io/api-6115006.md):

UtbCharge:addRecurringCharge

- API Documentation (Legacy APIs) > API Guide > Account Charges [Get Recurring Charge Details](https://octane-api.apidog.io/api-6115007.md):

UtbCharge:getRecurringChargeDetails

- API Documentation (Legacy APIs) > API Guide > Account Charges [Add a Manual Charge](https://octane-api.apidog.io/api-6115009.md):

UtbCharge:addManualCharge

- API Documentation (Legacy APIs) > API Guide > ConnectYou [Create a Number Reservation](https://octane-api.apidog.io/api-6106854.md):

UtbConnectYouHostedVoice:createNumberReservation

- API Documentation (Legacy APIs) > API Guide > ConnectYou [Get Available Numbers](https://octane-api.apidog.io/api-6106856.md):

UtbConnectYouHostedVoice:getAvailableNumbers

- API Documentation (Legacy APIs) > API Guide > ConnectYou [queryResiEndPointService](https://octane-api.apidog.io/api-6106857.md):

UtbConnectYouHostedVoice:queryResiEndpointService

- API Documentation (Legacy APIs) > API Guide > ConnectYou [Query a Business SIP Trunk Service](https://octane-api.apidog.io/api-6106859.md):

UtbConnectYouHostedVoice:queryBusSipTrunkService

- API Documentation (Legacy APIs) > API Guide > ConnectYou [Get Zone Detail](https://octane-api.apidog.io/api-6106860.md):

UtbConnectYouHostedVoice:getZoneDetail

- API Documentation (Legacy APIs) > API Guide > ConnectYou [Get Number Detail](https://octane-api.apidog.io/api-6106861.md):

UtbConnectYouHostedVoice:getNumberDetail

- API Documentation (Legacy APIs) > API Guide > Contact Log [Get Contact Log Types](https://octane-api.apidog.io/api-6114960.md):

UtbContact:getContactTypes

- API Documentation (Legacy APIs) > API Guide > Contact Log [Add a Contact Log](https://octane-api.apidog.io/api-6114961.md):

UtbContact:addContact

- API Documentation (Legacy APIs) > API Guide > Contact Log [Update a Contact Log](https://octane-api.apidog.io/api-6114962.md):

UtbContact:updateContact

- API Documentation (Legacy APIs) > API Guide > Contact Log [Query Contact Logs](https://octane-api.apidog.io/api-6114963.md):

UtbContact:getContactList

- API Documentation (Legacy APIs) > API Guide > Device [getSupplierStockDetail](https://octane-api.apidog.io/api-6114997.md): - API Documentation (Legacy APIs) > API Guide > Device [getSupplierProduct](https://octane-api.apidog.io/api-6114998.md): - API Documentation (Legacy APIs) > API Guide > Device [getSupplierFreightOption](https://octane-api.apidog.io/api-6114999.md): - API Documentation (Legacy APIs) > API Guide > Device [orderDevice](https://octane-api.apidog.io/api-6115000.md): - API Documentation (Legacy APIs) > API Guide > Mobile [Get Mobile Provisioning Product Catalogue](https://octane-api.apidog.io/api-5643906.md):

UtbMobile:getProductCatalogue

- API Documentation (Legacy APIs) > API Guide > Mobile [Query a Mobile Service](https://octane-api.apidog.io/api-5643909.md):

UtbMobile:queryService

- API Documentation (Legacy APIs) > API Guide > Mobile [Query Mobile Add Ons](https://octane-api.apidog.io/api-5643905.md):

UtbMobile:queryServiceAddons

- API Documentation (Legacy APIs) > API Guide > Mobile [Query Mobile Feature Settings](https://octane-api.apidog.io/api-5643907.md):

UtbMobile:queryServiceFeatureSettings

- API Documentation (Legacy APIs) > API Guide > Mobile [Query Mobile Balance](https://octane-api.apidog.io/api-5643911.md):

UtbMobile:queryBalanceV3

- API Documentation (Legacy APIs) > API Guide > Notifications [createNotification](https://octane-api.apidog.io/api-6114958.md): - API Documentation (Legacy APIs) > API Guide > Notifications [notificationManageTemplate](https://octane-api.apidog.io/api-6114959.md): - API Documentation (Legacy APIs) > API Guide > Pooled Resource [Reserve a Resource ](https://octane-api.apidog.io/api-5703190.md):

UtbPooledResource:reserveResources

- API Documentation (Legacy APIs) > API Guide > Pooled Resource [Unreserve a Resource](https://octane-api.apidog.io/api-5703189.md):

UtbPooledResource:unreserveResources

- API Documentation (Legacy APIs) > API Guide > Pooled Resource [Select a Resource](https://octane-api.apidog.io/api-5703193.md):

UtbPooledResource:selectResource

- API Documentation (Legacy APIs) > API Guide > Pooled Resource [Query Resource](https://octane-api.apidog.io/api-5703192.md):

UtbPooledResource:queryResources

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Create a Mobile Service (New Number)](https://octane-api.apidog.io/api-5711953.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Create a Mobile Service (Port In Number)](https://octane-api.apidog.io/api-5740686.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Create a Pre-Activation Mobile Order (New Number)](https://octane-api.apidog.io/api-5740693.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Bar/Unbar/Disconnect a Mobile Service](https://octane-api.apidog.io/api-5713965.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Change Mobile Rate Plan](https://octane-api.apidog.io/api-5714477.md):

UtOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Change a Mobile Number](https://octane-api.apidog.io/api-5717948.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Replace a SIM Card](https://octane-api.apidog.io/api-5717956.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Modify Mobile Feature(s)](https://octane-api.apidog.io/api-5740505.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Modify Mobile Feature Setting(s)](https://octane-api.apidog.io/api-5740526.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Change Excess Spend Limit](https://octane-api.apidog.io/api-5740625.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Add a Once-off Bolt On](https://octane-api.apidog.io/api-5740656.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Add a Recurring Bolt On Pack](https://octane-api.apidog.io/api-5740669.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile Order [Remove a Recurring Bolt On Pack](https://octane-api.apidog.io/api-5740672.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile (Data Pool) Order [Create a Data Pool](https://octane-api.apidog.io/api-5760358.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile (Data Pool) Order [Add Consumers to Data Pool](https://octane-api.apidog.io/api-5865791.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Mobile (Data Pool) Order [Remove Consumers from Data Pool](https://octane-api.apidog.io/api-5866771.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Create a New Business SIP Trunk](https://octane-api.apidog.io/api-6936465.md): This service is to be exposed by the Octane application. This service will be used by external systems such as the Service Provider and other Telcoinabox systems/sites to create a new Business SIP Trunk ServiceType on a customer account in Octane. Note that this API can be used to create SIP trunks for the following products: Business SIP Trunk, Unite Calling, Unite Calling Thin, Advanced PBX. See the Integration Guides for more details on how to add each particular service. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Bar/Unbar International Calls on a Business SIP Trunk](https://octane-api.apidog.io/api-6938039.md): The purpose of this Interface Contract (IC) is to capture the high-level interface requirements for the synchronous request-reply service orderCreate() to be exposed by Octane. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Suspend Business SIP Trunk](https://octane-api.apidog.io/api-6938127.md): The purpose of this Interface Contract (IC) is to capture the high-level interface requirements for the synchronous request-reply service orderCreate() to be exposed by Octane. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Unsuspend Business SIP Trunk](https://octane-api.apidog.io/api-6938135.md): The purpose of this Interface Contract (IC) is to capture the high-level interface requirements for the synchronous request-reply service orderCreate() to be exposed by Octane. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Deactivate Business SIP Trunk](https://octane-api.apidog.io/api-6938528.md): The purpose of this Interface Contract (IC) is to capture the high-level interface requirements for the synchronous request-reply service orderCreate() to be exposed by Octane. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Port Numbers to a Business SIP Trunk](https://octane-api.apidog.io/api-6938546.md): This service is to be exposed by the Octane application. This service will be used by external systems such as the Service Provider and other Telcoinabox systems/sites to port numbers to an existing SIP Trunk service. - API Documentation (Legacy APIs) > API Guide > Order > ConnectYou (SIP Trunk) Order [Configure Business SIP Trunk](https://octane-api.apidog.io/api-6939688.md): This service is to be exposed by the Octane application. This service will be used by external systems such as the Service Provider and other Telcoinabox systems/sites to create a new Business SIP Trunk ServiceType on a customer account in Octane. - API Documentation (Legacy APIs) > API Guide > Order > Other Rated Order [Create an Other Rated Service](https://octane-api.apidog.io/api-5868096.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order > Other Rated Order [Change Access of an Other Rated Service](https://octane-api.apidog.io/api-5869890.md):

UtbOrder:orderCreate

- API Documentation (Legacy APIs) > API Guide > Order [Create an Order](https://octane-api.apidog.io/api-5707515.md): - API Documentation (Legacy APIs) > API Guide > Order [Cancel an Order](https://octane-api.apidog.io/api-5707517.md):

utbOrder:orderCancel

- API Documentation (Legacy APIs) > API Guide > Order [Query an Order](https://octane-api.apidog.io/api-5707518.md):

UtbOrder:orderQuery

- API Documentation (Legacy APIs) > API Guide > Order [Reset an Order](https://octane-api.apidog.io/api-5707519.md):

UtbOrder:orderReset

- API Documentation (Legacy APIs) > API Guide > Statements & Billing [Get a List of Customer Bills](https://octane-api.apidog.io/api-6114970.md):

UtbStatement:getStatement

- API Documentation (Legacy APIs) > API Guide > Statements & Billing [Get Charge Item Detail for a Bill](https://octane-api.apidog.io/api-6114972.md):

UtbStatement:getItemDetail

- API Documentation (Legacy APIs) > API Guide > Statements & Billing [Get a Single Bill PDF for a Customer](https://octane-api.apidog.io/api-6114973.md):

UtbStatement:getStmtPDF

- API Documentation (Legacy APIs) > API Guide > Statements & Billing [Get a Summary of a Bill](https://octane-api.apidog.io/api-6114974.md):

UtbStatement:getLineItem

- API Documentation (Legacy APIs) > API Guide > Unbilled Calls [Query Summary of Unbilled Calls & Charges](https://octane-api.apidog.io/api-6114989.md):

UtbCall:getUnbilledCallSummary

- API Documentation (Legacy APIs) > API Guide > Unbilled Calls [Query Detail of Unbilled Calls & Charges](https://octane-api.apidog.io/api-6114992.md):

UtbCall:getUnbilledCallsDetail

- API Documentation (Legacy APIs) > API Guide > OTP [Manage OTP (Get & Verify OTP)](https://octane-api.apidog.io/api-6274473.md):

UtbOTP:manageOTP