POST api/v1/recurringpayments/register

Set up a recurring payment. There must already be a customer/payment profile already on the system. Important to understand, you cannot process a new recurring payment today. If the start date has today's date, the first processing date will today's date plus the frequency interval, e.g. a daily frequency will have the first processing date set to tomorrow, a weekly frequency will have the first processing date set to 7 days from now.

Request Information

URI Parameters

None.

Body Parameters

RecurringPaymentsBindingModel

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		RecurringPaymentsRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "CustomerProfileId": "123456789",
    "Recurring": {
      "PaymentProfileId": "123456789",
      "Amount": "20.50 (include decimal places)",
      "CurrencyCode": "USD (see ISO 4217 for correct currency codes)",
      "Frequency": "(0 - daily, 1 - weekly, 2 - monthly, 3 - quarterly, 4 - annually)",
      "StartDateTime": "2026-01-26 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format - preferably a date beyond today)",
      "EndDateTime": "2026-04-25 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format)",
      "Description": "Monthly subscription package"
    },
    "RevenuePartner": null,
    "Marketing": null
  }
}

application/xml, text/xml

Sample:

<RecurringPaymentsBindingModel 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>
    <Marketing i:nil="true" />
    <Recurring>
      <Amount>20.50 (include decimal places)</Amount>
      <CurrencyCode>USD (see ISO 4217 for correct currency codes)</CurrencyCode>
      <Description>Monthly subscription package</Description>
      <EndDateTime>2026-04-25 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format)</EndDateTime>
      <Frequency>(0 - daily, 1 - weekly, 2 - monthly, 3 - quarterly, 4 - annually)</Frequency>
      <PaymentProfileId>123456789</PaymentProfileId>
      <StartDateTime>2026-01-26 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format - preferably a date beyond today)</StartDateTime>
    </Recurring>
    <RevenuePartner i:nil="true" />
  </Request>
</RecurringPaymentsBindingModel>

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": "2026-01-26 (YYYY-MM-DD - UTC format)"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.