MarkPaymentAsApplied

Description

This method is used to mark the payment as applied.

Syntax

PaymentResponse MarkPaymentAsApplied(SecurityToken securityToken, string invoiceNumber, string paymentInternalId);

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required).
string	invoiceNumber	Invoice number. (required).
string	paymentInternalId	Payment internal ID. (required).

Return Value

Type	Description
PaymentResponse	Returns the payment response

function markPaymentAsApplied(){
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '******-454757-4567457-********',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$markPaymentAsApplied = array(
'securityToken' => $securityToken,
'invoiceNumber' => 'in-123',
'paymentInternalId' => 21,
);
$markPaymentAsAppliedResponse = $client->MarkPaymentAsApplied($markPaymentAsApplied);
$markPaymentAsAppliedResponseResult = $markPaymentAsAppliedResponse->MarkPaymentAsAppliedResult;
}

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:MarkPaymentAsApplied>
                  <ebiz:securityToken>
                     <ebiz:SecurityId>*******-23f6-4466-a993-********</ebiz:SecurityId>
            <ebiz:UserId>?</ebiz:UserId>
            <ebiz:Password>?</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:invoiceNumber></ebiz:invoiceNumber>
         <ebiz:paymentInternalId>*******-0e37-48da-bcd3-********</ebiz:paymentInternalId>
      </ebiz:MarkPaymentAsApplied>
   </soapenv:Body>
  
  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">
      <MarkPaymentAsAppliedResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <MarkPaymentAsAppliedResult>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </MarkPaymentAsAppliedResult>
      </MarkPaymentAsAppliedResponse>
   </s:Body>
</s:Envelope>
</soapenv:Envelope>

public void markPaymentAsApplied()
{
  eBizService apiClient = new eBizService();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "********-90b4-4a38-ad78-********",
    UserId = "",
    Password = ""
    };
  var Response = apiClient.MarkPaymentAsApplied(securityToken, "00102565", "********-b521-4ef6-9456-********");
  Console.WriteLine(Response.Status);
  Console.WriteLine(Response.StatusCode);
  Console.WriteLine(Response.Error);
  Console.WriteLine(Response.ErrorCode);
}

Updated over 2 years ago