ModifyScheduledRecurringPaymentStatus
Description
This method is used to update specific recurring billing status.
Syntax
ModifyScheduledRecurringPaymentStatusResponse ModifyScheduledRecurringPaymentStatus(SecurityToken securityToken, string scheduledPaymentInternalId, int statusId);
Arguments
Type | Name | Description |
---|---|---|
SecurityToken | securityToken | Merchant security token: used to identify merchant and validate transaction. (required) |
string | scheduledPaymentInternalId | Unique ID assigned by the internal system for an existing recurring payment schedule. (required) |
int | statusId | .Possible value: 0 Active 1 Suspended 2 Expired 3 Canceled |
Return Value
Examples
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:ModifyScheduledRecurringPaymentStatus>
ebiz:securityToken>
<ebiz:SecurityId>********-57c3-4f40-8e36-17bf6fd5b2cb</ebiz:SecurityId>
<ebiz:UserId>Ucbs01</ebiz:UserId>
<ebiz:Password>cbs123!</ebiz:Password>
</ebiz:securityToken>
<ebiz:scheduledPaymentInternalId>********-fa4f-4306-8e23-a9e80ef3c0fe</ebiz:scheduledPaymentInternalId>
<ebiz:statusId>3</ebiz:statusId>
</ebiz:ModifyScheduledRecurringPaymentStatus>
</soapenv:Body>
</soapenv:Envelope>
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">
<ModifyScheduledRecurringPaymentStatusResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<ModifyScheduledRecurringPaymentStatusResult>
<Status>Success</Status>
<StatusCode>1</StatusCode>
<Error/>
<ErrorCode>0</ErrorCode>
</ModifyScheduledRecurringPaymentStatusResult>
</ModifyScheduledRecurringPaymentStatusResponse>
</s:Body>
</s:Envelope>
IeBizServiceClient client = new IeBizServiceClient();
SecurityToken securityToken = new SecurityToken();
securityToken.UserId = GatewayInfo.ApiUserId;
securityToken.SecurityId = GatewayInfo.ApiSecurityId;
securityToken.Password = GatewayInfo.ApiPassword;
int statudId = 1
ModifyScheduledRecurringPaymentStatusResponse modifyScheduledRecurringPaymentStatusResponse = client.ModifyScheduledRecurringPaymentStatus(securityToken, scheduledPaymentInternalId, statudId);
Updated over 2 years ago