Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Update a recurring sale

post/API/PaymentPageRequest.svc/RecurringSaleUpdate

Request body

AutoChargeboolean nullable

Charge the Recurring Sale Automaticlly.

Default: Recurring settings

EndDatestring date nullable

Set End Date for the Recurring Sale.

~ Date format DD-MM-YY Length: 10 characters Default: Recurring settings

IPNURLstring url nullable

IPN URL - After Success Payment.

Length: 15 to 500 Default: Recurring settings

IsActiveboolean nullable

Activate/Deactivate Recurring Settings.

Default: Recurring settings

RecurringConcatMonth-1 | 0 | 1 nullable

Concatenate the Number of Chosen Month to Item Description.

~ Cancel option - under the recurring settings Options (-1 = Past month 0 = Current month 1 = Next month) Default: Recurring settings

RecurringCycle1 | 2 | 3 nullable

Set Time Phrase to Charge a Recurring Sale.

Options (1 = day 2 = week 3 = month) Default: Recurring settings

RecurringDay1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 nullable

Set the Charge Day of the Month in a Recurring Sale.

Range: 1-28 Default: Recurring settings

RecurringOffsetinteger nullable

Forward or Backward Recurring Charge.

Range: -999 to 999 Default: Recurring settings

RecurringSaleIdstring uuid required

Recurring Sale Identifier.

Format: UUID Default: No

RecurringStepinteger nullable

Set the Time Phrase to Charge a Recurring Sale.

~ Every X day/week/month Range: 1 to 999 Default: Page recurring settings

Example request

{
  "AutoCharge": true,
  "EndDate": "01-03-2025",
  "IPNURL": "http://9188dde0.ngrok.io/test/ipn_listener.php",
  "IsActive": true,
  "RecurringConcatMonth": 1,
  "RecurringCycle": 3,
  "RecurringDay": 10,
  "RecurringOffset": -1,
  "RecurringSaleId": "1627aea5-8e0a-4371-9022-9b504344e724",
  "RecurringStep": 1
}

Response

Successfully updated the recurring sale items

error_codeinteger

Response Error Code.

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Statusinteger

The Response Error/Status Number (0 = Success)