create a schedule id to be used with recurring payments

create a schedule id to be used with recurring payments

multipart/form-data

Request Body

• action string required

  Action to create a new schedule - fixed value

• client_key uuid required

  Possible values: <= 255 characters

  Unique key (Merchant key)

• hash string required

  Special signature to validate your request to Payment Platform

• name string required

  name of the schedule id

• interval_length integer required

  Interval length - how often the payments occurs. Cannot be set 0. For example, to set a schedule for payments every 15 days, you need to set:interval_length = 15, interval_unit = day

• interval_unit string required

  Possible values are day and month

• day_of_month integer

  Possible values: >= 1 and <= 31

  Day of month when payment has to occur. Available only if interval_unit = month. Possible values: from 1 to 31. If day_of_month = 29, 30, or 31 and there are no days 29, 30, or 31 in the month, then the last day of the month is used. If day_of_month is not defined, then payment occurs on the day the initiating payment is created

• payments_count integer

  Payments count in schedule

• delays integer

  Number of skipped intervals of the scheduled before payment cycle starts

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• action string

  Action to create a new schedule - fixed value

• result string
• id uuid

  Possible values: <= 255 characters

{
  "action": "CREATE_SCHEDULE",
  "result": "SUCCESS",
  "id": "84f2c56e-fa1a-11ed-bfb3-5acabb05365f"
}

{
  "action": "CREATE_SCHEDULE",
  "result": "SUCCESS",
  "id": "84f2c56e-fa1a-11ed-bfb3-5acabb05365f"
}

Loading...