MarkRecurringPaymentAsApplied

Description

The MarkRecurringPaymentAsApplied method marks a recurring payment as applied by removing it from the list of recurring payments returned by SearchRecurringPayments.

Syntax

PaymentResponse MarkRecurringPaymentAsApplied(SecurityToken securityToken, string invoiceNumber, string paymentInternalId)

Arguments

Type	Name	Req	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	invoiceNumber	O	Invoice number associated with the Payment object.
string	paymentInternalId	R	Identifies the Payment object to mark as applied.

Return Value

Type	Description
PaymentResponse	Indicates whether the operation was successful.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:MarkRecurringPaymentAsApplied>
         <ebiz:securityToken>
            <ebiz:SecurityId>************434c-b126************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:invoiceNumber/>
         <ebiz:paymentInternalId>************417a-822b************</ebiz:paymentInternalId>
      </ebiz:MarkRecurringPaymentAsApplied>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

SecurityToken securityToken = new SecurityToken
{
    SecurityId = "**********4bf0-91cd**********",
    UserId = "",
    Password = ""
};

string invoiceNumber = "";
string paymentInternalId = "************4c70-be2f************";

var result = client.MarkRecurringPaymentAsApplied(securityToken, invoiceNumber, paymentInternalId);
Console.WriteLine($"{result.Status}");

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '************4b3e-a6c6************',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
);
 $params = array(
     'securityToken' => $securityToken,
     'invoiceNumber' => '',
     'paymentInternalId' => '************47d3-b8b5************'
 );

$response = $client->MarkRecurringPaymentAsApplied($params);

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">
      <MarkRecurringPaymentAsAppliedResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <MarkRecurringPaymentAsAppliedResult>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </MarkRecurringPaymentAsAppliedResult>
      </MarkRecurringPaymentAsAppliedResponse>
   </s:Body>
</s:Envelope>

<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">
      <MarkRecurringPaymentAsAppliedResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <MarkRecurringPaymentAsAppliedResult>
            <Status>Error</Status>
            <StatusCode>0</StatusCode>
            <Error>Update Record error</Error>
            <ErrorCode>3</ErrorCode>
         </MarkRecurringPaymentAsAppliedResult>
      </MarkRecurringPaymentAsAppliedResponse>
   </s:Body>
</s:Envelope>

Updated 4 months ago