POST api/v1/recurringpayments/remove

Remove a recurring payment.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		RecurringPaymentsActionRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "CustomerProfileId": "123456789",
    "RecurringPaymentId": "123456789"
  }
}

application/xml, text/xml

Sample:

<RecurringPaymentsActionBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <CustomerProfileId>123456789</CustomerProfileId>
    <RecurringPaymentId>123456789</RecurringPaymentId>
  </Request>
</RecurringPaymentsActionBindingModel>

Response Information

Resource Description

RecurringPaymentsOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.
Response		IRecurringPaymentsResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  },
  "Response": {
    "CustomerProfileId": "123456789",
    "RecurringPaymentId": "123456789",
    "NextProcessingDate": "2025-04-20 (YYYY-MM-DD - UTC format)"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.