API Reference
  1. Features

Payment Schedules

post
https://svra.interpaypos.com:1443/

Creates and manages scheduled recurring payments against a stored card. Supports creating schedules, adding/updating/removing payments, attaching cards, and retrieving schedule status.

Creates and manages scheduled recurring payments against a stored card. Supports creating schedules, adding/updating/removing payments, attaching cards, and retrieving schedule status.

Body Params

Create a new Schedule with the option to attach card data and payments at the same time.

string
required
^[a-zA-Z0-9]{8}$

Terminal ID of the merchant (8 alphanumeric characters). Must always be the first field.

string
required
^[a-zA-Z0-9]+$

Password for the Terminal ID (provided by SportsPay).

string
enum
required

Type of transaction (L for payment schedule activity).

Allowed:
string
enum
required

Denotes the activity to apply to the schedule (CS for create schedule)

Allowed:
string
length ≤ 36
^[a-zA-Z0-9-]+$

Unique identifier for the schedule (optional, generated by gateway if omitted)

string
required
^[a-zA-Z0-9-]{5,20}$

Invoice number associated with the Schedule (5-20 characters; letters, digits and -).

string
^[\w\s\W]{1,60}$

Description of payment (up to 60 characters; accepts alphanumeric, spaces, symbols and punctuation marks).

string
length ≤ 3
^[CSAWN]{1,3}$

Follow-up emails sent to the cardholder for this schedule, replacing the partner-level settings configured at integration (set at creation only; not returned by GS).
Omit to use the configured settings.

  • C — decline follow-ups and card update requests
  • S — schedule-changed notifications
  • A — approved payment receipts
  • W — upcoming payment reminders (3 days before)
  • N — no follow-up emails
string
^\d{9,25}$

Credit card number (9-25 digits).

string
^\d{4}$

Card expiry date in MMYY format (total of 4 digits without spaces or slashes).

string
^\d{3,4}$

Card CVV (3-4 digits on back of credit card).

string
^[a-zA-Z0-9 \-'.]{1,40}$

Customer's name (max 40 characters; accepts alphanumeric, spaces, -, ', and .). Required if attaching card data.

string
^[\w\.-]+@[a-zA-Z\d\.-]+\.[a-zA-Z]{2,}$

Customer's email address (max 60 characters; accepts standard email characters: alphanumeric and @ . ! # $ % + - _ { | } ~). Required if attaching card data.

PYMTS
array of objects

A list of the payments in the schedule.

PYMTS
Response

Updated 14 days ago

Related

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago

Related

Did this page help you?