Payment Schedules

Body Params

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

string
required

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

string
required

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 between 10 and 40

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

string
required

Invoice number associated with the Schedule (max 5-20 alphanumeric characters).

string

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

string

Credit card number (9-25 digits).

string

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

string

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

string

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

string

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

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain