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.

Body Params

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

TERMID

string

required

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

PASS

string

required

Password for the Terminal ID (provided by SportsPay).

TYPE

string

enum

required

Type of transaction (L for payment schedule activity).

Allowed:

SUBTYPE

string

enum

required

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

Allowed:

SCHEDID

string

length between 10 and 40

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

INVOICE

string

required

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

DESC

string

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

CARD

string

Credit card number (9-25 digits).

EXP

string

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

CVV2

string

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

CUSTNAME

string

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

CUSTEMAIL

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response