NoveroUser

GetUserDetails

Description

Retrieve details of the user account associated with the current API session login.

Parameters

This function takes no parameters.

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
            <Request target="NoveroUser" name="GetUserDetails" id="TestRequest"/>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroUser', 'GetUserDetails', 'TestRequest');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('TestRequest');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'GetUserDetails', 'TestRequest')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'GetUserDetails', 'TestRequest')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroUser", "GetUserDetails", "TestRequest");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
      <Response target="NoveroUser" name="GetUserDetails" Code="200" RequestId="TestRequest">
          <Username>sales@ttnc.co.uk</Username>
          <Reference>C300001</Reference>
          <Name>TTNC Sales</Name>
          <FullName>TTNC</FullName>
          <LastName>Sales</LastName>
          <Email>sales@ttnc.co.uk</Email>
          <Company>TTNC Limited</Company>
          <Phone>02031511000</Phone>
          <Mobile>07812345678</Mobile>
          <Address1>4 Wells Street</Address1>
          <Web>www.ttnc.co.uk</Web>
          <City>Chelmsford</City>
          <County>ESSEX</County>
          <PostCode>CM1 1HZ</PostCode>
          <Country>GB</Country>
          <Phone>02031511000</Phone>
          <Mobile>07812345678</Mobile>
          <Balance>483.594</Balance>
          <VirtualBalance>14.949</VirtualBalance>
          <SMSCredits>94</SMSCredits>
          <NumberCount>70</NumberCount>
          <Status>Active</Status>
          <UnreadSystemEventsCount>2</UnreadSystemEventsCount>
          <UnreadNoveroEventsCount>0</UnreadNoveroEventsCount>
      </Response>
  </NoveroResponse>

GetCards

Description

List all saved cards on the account associated with the current API session. The TokenId can be passed to Order::PlaceOrder in order to pay for items.

Parameters

This function takes no parameters.

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
            <Request target="NoveroUser" name="GetCards" id="TestRequest"/>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroUser', 'GetCards', 'TestRequest');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('TestRequest');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'GetCards', 'TestRequest')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'GetCards', 'TestRequest')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroUser", "GetCards", "TestRequest");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
    <Response target="NoveroUser" name="GetCards" Code="200" RequestId="TestRequest">
      <Cards>
        <Card>
          <TokenId>12883</TokenId>
          <BillingCardMasked>***********5969</BillingCardMasked>
          <BillingCardExpiry>07/14</BillingCardExpiry>
          <BillingCardType>VISA</BillingCardType>
          <FlagCardDefault>0</FlagCardDefault>
          <FlagCardActive>1</FlagCardActive>
          <FlagCardFailed>0</FlagCardFailed>
          <FlagCardExpired>0</FlagCardExpired>
          <FlagCardAutoTopups>0</FlagCardAutoTopups>
        </Card>
      </Cards>
    </Response>
  </NoveroResponse>

AddCard

Description

Adds a saved card to the account associated with the current API session. Returns a TokenId for use with Order::PlaceOrder.

Parameters

string CardName The name of the card holder, as it appears on the card.
int CardNumber The 16 digit card number, without spaces.
string ExpiryMonth The month that the card expires in a two digit format. For example '05' (May).
string ExpiryYear The year that the card expires in a two digit format. For example '15' (2015).
int CV2 The last 3-4 digits on the signature strip of the specified card. This must be provided for security reasons.
string Type The card type. Available options;
Visa VISA
Visa Delta DELTA
Visa Debit DELTA
Visa Electron UKE
MasterCard MC
Solo SOLO
Switch SWITCH
UK Maestro SWITCH
American Express AMEX
string Address1 The first line of the address that the card is registered to.
string City The name of the city for the address that the card is registered to.
string Postcode The postcode for the address that the card is registered to.
string Country The two letter ISO code for the country for the address that the card is registered to.
string StartMonth The month that the card expires in a two digit format. For example '08' (August). This field is required if the Type parameter has been set to SWITCH.
string StartYear The year that the card expires in a two digit format. For example '12' (2012). This field is required if the Type parameter has been set to SWITCH.
string IssueNumber The issue number of the card. This is only applicable if the Type parameter is set to SWITCH, however it is not a required parameter itself.
RequiredOptional

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
          <Request target="NoveroUser" name="AddCard" id="TestRequest">
            <CardName>Mr Test Testington</CardName>
            <CardNumber>4485663919957945</CardNumber>
            <ExpiryMonth>03</ExpiryMonth>
            <ExpiryYear>15</ExpiryYear>
            <CV2>123</CV2>
            <Type>VISA</Type>
            <Address1>1 The Road</Address1>
            <City>Testham</City>
            <Postcode>TE57 73ST</Postcode>
            <Country>GB</Country>
          </Request>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroUser', 'AddCard', 'TestRequest');
            $Request->SetData('CardName', 'Mr Test Testington');
            $Request->SetData('CardNumber', '4485663919957945');
            $Request->SetData('ExpiryMonth', '03');
            $Request->SetData('ExpiryYear', '15');
            $Request->SetData('CV2', '123');
            $Request->SetData('Type', 'VISA');
            $Request->SetData('Address1', '1 The Road');
            $Request->SetData('City', 'Testham');
            $Request->SetData('Postcode', 'TE57 73ST');
            $Request->SetData('Country', 'GB');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('TestRequest');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'AddCard', 'TestRequest')
        request.setdata('CardName', 'Mr Test Testington')
        request.setdata('CardNumber', '4485663919957945')
        request.setdata('ExpiryMonth', '03')
        request.setdata('ExpiryYear', '15')
        request.setdata('CV2', '123')
        request.setdata('Type', 'VISA')
        request.setdata('Address1', '1 The Road')
        request.setdata('City', 'Testham')
        request.setdata('Postcode', 'TE57 73ST')
        request.setdata('Country', 'GB')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'AddCard', 'TestRequest')
        request.setdata('CardName', 'Mr Test Testington')
        request.setdata('CardNumber', '4485663919957945')
        request.setdata('ExpiryMonth', '03')
        request.setdata('ExpiryYear', '15')
        request.setdata('CV2', '123')
        request.setdata('Type', 'VISA')
        request.setdata('Address1', '1 The Road')
        request.setdata('City', 'Testham')
        request.setdata('Postcode', 'TE57 73ST')
        request.setdata('Country', 'GB')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroUser", "AddCard", "TestRequest");
                request.setData("CardName", "Mr Test Testington");
                request.setData("CardNumber", "4485663919957945");
                request.setData("ExpiryMonth", "03");
                request.setData("ExpiryYear", "15");
                request.setData("CV2", "123");
                request.setData("Type", "VISA");
                request.setData("Address1", "1 The Road");
                request.setData("City", "Testham");
                request.setData("Postcode", "TE57 73ST");
                request.setData("Country", "GB");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
    <Response target="NoveroUser" name="AddCard" Code="200" RequestId="TestRequest">
      <Token>
        <TokenId>15084</TokenId>
      </Token>
    </Response>
  </NoveroResponse>

ChangeCardOptions

Description

Changes the options of a card saved to the TTNC system.

Parameters

int TokenId The TokenId of the card you are changing the options for.
bool SetDefault Sending this parameter as a value equivalent to TRUE will set the specified card as the Default Card for automatic billing. You can only have one Default Card per account. Setting a card to be the Default card will demote any other cards from being the Default Card.
bool EnableTopup Sending this parameter as a value equivalent to TRUE will set the specified card to be used as Auto Topup. Sending this parameter as a value equivalent to FALSE OR Omitting this parameter from the request, will set the card to NOT be used for Automatic Topup.
String Status Set the specified saved card to be used (string Active) or not used (string Disabled) for automatic billing.
RequiredOptional

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
            <Request target="NoveroUser" name="ChangeCardOptions" id="TestRequest">
                <TokenId>15988</TokenId>
                <SetDefault>1</SetDefault>
                <EnableTopup>1</EnableTopup>
                <Status>Disabled</Status>
            </Request>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroUser', 'ChangeCardOptions', 'TestRequest');\
            $Request->SetData('TokenId', 1);
            $Request->SetData('SetDefault', 1);
            $Request->SetData('EnableTopup', 1);
            $Request->SetData('Status', 'Disabled');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('TestRequest');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'ChangeCardOptions', 'TestRequest')
        request.setdata('TokenId', 15988)
        request.setdata('SetDefault', 1)
        request.setdata('EnableTopup', 1)
        request.setdata('Status', 'Disabled')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroUser', 'ChangeCardOptions', 'TestRequest')
        request.setdata('TokenId', 15988)
        request.setdata('SetDefault', 1)
        request.setdata('EnableTopup', 1)
        request.setdata('Status', 'Disabled')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroUser", "ChangeCardOptions", "TestRequest");
                request.setData("TokenId", 15988);
                request.setData("SetDefault", 1);
                request.setData("EnableTopup", 1);
                request.setData("Status", "Disabled");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
      <Response target="NoveroUser" name="ChangeCardOptions" Code="200" RequestId="TestRequest">
          <ResponseMessage>1</ResponseMessage>
          <Success>1</Success>
      </Response>
  </NoveroResponse>