AddApplicationTransaction

Description

The AddApplicationTransaction method adds an ApplicationTransactionDetails object to the EBizCharge platform.

Syntax

ApplicationTransactionResponse AddApplicationTransaction(SecurityToken securityToken, ApplicationTransactionRequest applicationTransactionRequest)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
ApplicationTransactionRequest	applicationTransactionRequest	R	Required Fields `CustomerInternalId` `TransactionId` `TransactionTypeId` `LinkedToTypeId` `LinkedToInternalId`

Return Value

Type	Description
ApplicationTransactionResponse	Indicates whether the object was successfully added. Otherwise, a fault is returned.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
  <soapenv:Header/>
  <soapenv:Body>
    <ebiz:AddApplicationTransaction>
      <ebiz:securityToken>
        <ebiz:SecurityId>*************-4621-b899-************</ebiz:SecurityId>
        <ebiz:UserId/>
        <ebiz:Password/>
      </ebiz:securityToken>
      <ebiz:applicationTransactionRequest>
        <ebiz:CustomerInternalId>*************-46a8-909a-************</ebiz:CustomerInternalId>
        <ebiz:TransactionId>******6027</ebiz:TransactionId>
        <ebiz:TransactionTypeId>Authorization</ebiz:TransactionTypeId>
        <ebiz:SoftwareId/>
        <ebiz:LinkedToTypeId>SalesOrder</ebiz:LinkedToTypeId>
        <ebiz:LinkedToInternalId>*************-46a8-909a-************</ebiz:LinkedToInternalId>
        <ebiz:LinkedToExternalUniqueId/>
        <ebiz:TransactionDate/>
        <ebiz:TransactionNotes/>
        <ebiz:TransactionExternalReferenceNumber/>
        <ebiz:TransactionCustomFields>
          <!--Zero or more repetitions:-->
          <ebiz:EbizCustomField>
            <ebiz:FieldId/>
            <ebiz:FieldCaption/>
            <ebiz:FieldName/>
            <ebiz:FieldValue/>
            <ebiz:FieldType/>
            <ebiz:FieldDataType/>
            <ebiz:FieldDescription/>
          </ebiz:EbizCustomField>
        </ebiz:TransactionCustomFields>
      </ebiz:applicationTransactionRequest>
    </ebiz:AddApplicationTransaction>
  </soapenv:Body>
</soapenv:Envelope>

public void AddApplicationTransaction()
{
  eBizService apiClient = new eBizService();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "*******-c870-41b8-aa5c-********",
    UserId = "",
    Password = ""
    };
  ApplicationTransactionRequest transactionRequest = new ApplicationTransactionRequest();
  transactionRequest.CustomerInternalId = "********-25b2-473e-af6b-********";
  transactionRequest.TransactionId = "2750394928";
  transactionRequest.TransactionTypeId = "Sale";
  transactionRequest.LinkedToTypeId = "Test123";
  transactionRequest.LinkedToInternalId = "********-25b2-473e-af6b-********";
  transactionRequest.LinkedToExternalUniqueId = "Test123";
  transactionRequest.TransactionDate = "04/27/2022";
  transactionRequest.TransactionNotes = "Sample notes";
  var response = apiClient.AddApplicationTransaction(securityToken, transactionRequest);
  Console.WriteLine(response.Status);
  Console.WriteLine(response.StatusCode);
  Console.WriteLine(response.Error);
  Console.WriteLine(response.ErrorCode);
  Console.ReadLine();
}

public function AddApplicationTransaction()
{
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-********',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );
  $addRequest = array(
    'securityToken' => $securityToken,
    'applicationTransactionRequest' => array(
      'CustomerInternalId' => '********-454757-4567457-********',
      'TransactionId' => '3454354',
      'TransactionTypeId' => 'sale',
      'LinkedToInternalId' => '467457-454237-4567457-4222',
      'SoftwareId' => 'PHP',
      'TransactionDate' => date('Y-m-d H:i:s'),
      'TransactionNotes' => 'Order Id: 123',
      'LinkedToTypeId' => 'SalesOrder',
      'LinkedToExternalUniqueId' => 'order123'
    )
  );
  $response = $this->soapClient->AddApplicationTransaction($addRequest);
  $result = $response->AddApplicationTransactionResult;
}

Example Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AddApplicationTransactionResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <AddApplicationTransactionResult>
            <ApplicationTransactionInternalId>*************-4094-9e1b-************</ApplicationTransactionInternalId>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </AddApplicationTransactionResult>
      </AddApplicationTransactionResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidData</faultcode>
         <faultstring xml:lang="en-US">Invalid CustomerInternalId</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>