Recurring Schedule

Cancel a recurring payment schedule

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

SchedIDintegerOptional

The unique identifier for the schedule to be canceled

Example: 10

Responses

200

Successfully canceled the recurring schedule

application/json

post

POST /APIcardProcREST/v1.0.0/RecurringSchedule/Cancel HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 14

{
  "SchedID": 10
}

200

Successfully canceled the recurring schedule

{
  "RecurringSchedule_CancelResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Cancel of SchedID 10 For $10.00 On 6/23/2019",
    "ScheduledPayment": {
      "AcctHolderID": 782,
      "AcctNo": "0119",
      "ConsentID": 396,
      "ConsentType": "S",
      "DueOn": "2024-12-01 11:19:01",
      "ID": 282,
      "LastName": "Draper",
      "MerchID": 1,
      "OfTotalPayment": 100,
      "OfTotalPayments": 10,
      "PaymentAmt": 300,
      "PaymentNum": 1,
      "Period": "WEEKLY",
      "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
      "RStatus": "S",
      "SchedNum": 59,
      "Tries": 0,
      "TxID": -1
    }
  }
}

Modify a recurring payment schedule

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

SchedIDintegerOptional

The unique identifier for the schedule to be modified

Example: 10

PaymentAmountnumber · floatOptional

The new $ payment amount for the schedule

Example: 10

DueDatestring · dateOptional

The new due date for the schedule

Example: 2023-07-10

Responses

200

Successfully modified the recurring schedule

application/json

post

POST /APIcardProcREST/v1.0.0/RecurringSchedule/Modify HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 56

{
  "SchedID": 10,
  "PaymentAmount": 10,
  "DueDate": "2023-07-10"
}

200

Successfully modified the recurring schedule

{
  "RecurringSchedule_ModifyResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successful Reschedule of SchedID 10 For $10.00 On 7/10/2023",
    "ScheduledPayment": {
      "AcctHolderID": 782,
      "AcctNo": "0119",
      "ConsentID": 396,
      "ConsentType": "S",
      "DueOn": "2024-12-01 11:19:01",
      "ID": 282,
      "LastName": "Draper",
      "MerchID": 1,
      "OfTotalPayment": 100,
      "OfTotalPayments": 10,
      "PaymentAmt": 300,
      "PaymentNum": 1,
      "Period": "WEEKLY",
      "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
      "RStatus": "S",
      "SchedNum": 59,
      "Tries": 0,
      "TxID": -1
    }
  }
}

Process scheduled payments

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

MerchIDintegerOptional

The merchant identifier for processing payments

Example: 1

Responses

200

Successfully processed scheduled payments

application/json

post

POST /APIcardProcREST/v1.0.0/RecurringSchedule/ProcessScheduledPayments HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 13

{
  "MerchID": 1
}

200

Successfully processed scheduled payments

{
  "ProcessScheduledPaymentsResult": {
    "ApprovedPayments": [
      {
        "AcctNo": "1111",
        "CardHolder": "JOHN DOE",
        "CardType": "VI",
        "ConsentID": 6,
        "ConsentType": "S",
        "ErrMsg": "",
        "IsPartialApproval": false,
        "MerchID": 1,
        "PaymentAmt": 10,
        "PaymentDate": "2024-12-01 11:19:01",
        "PaymentNum": 1,
        "SEQ": "119",
        "SchedID": 1,
        "SchedNum": 1,
        "TxApproved": true,
        "TxID": 104,
        "TxnCode": "090944"
      }
    ],
    "DeclinedPayments": [
      {
        "AcctNo": "1111",
        "CardHolder": "JOHN DOE",
        "CardType": "VI",
        "ConsentID": 6,
        "ConsentType": "S",
        "ErrMsg": "",
        "IsPartialApproval": false,
        "MerchID": 1,
        "PaymentAmt": 10,
        "PaymentDate": "2024-12-01 11:19:01",
        "PaymentNum": 1,
        "SEQ": "119",
        "SchedID": 1,
        "SchedNum": 1,
        "TxApproved": true,
        "TxID": 104,
        "TxnCode": "090944"
      }
    ],
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumApproved": 2,
    "NumDeclined": 1,
    "NumPartialAuths": 0,
    "NumProcessed": 3,
    "RespMsg": "Total Processed: 3 Approved: 2 Declined: 1 Partial: 0"
  }
}

Process selected scheduled payments

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

SchedIDsinteger[]Optional

The list of schedule IDs to process

Example: [172]

Responses

200

Successfully processed selected scheduled payments

application/json

post

POST /APIcardProcREST/v1.0.0/RecurringSchedule/ProcessScheduledPaymentsSelective HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 18

{
  "SchedIDs": [
    172
  ]
}

200

Successfully processed selected scheduled payments

{
  "ProcessScheduledPaymentsSelectiveResult": {
    "ApprovedPayments": [
      {
        "AcctNo": "1111",
        "CardHolder": "JOHN DOE",
        "CardType": "VI",
        "ConsentID": 6,
        "ConsentType": "S",
        "ErrMsg": "",
        "IsPartialApproval": false,
        "MerchID": 1,
        "PaymentAmt": 10,
        "PaymentDate": "2024-12-01 11:19:01",
        "PaymentNum": 1,
        "SEQ": "119",
        "SchedID": 1,
        "SchedNum": 1,
        "TxApproved": true,
        "TxID": 104,
        "TxnCode": "090944"
      }
    ],
    "DeclinedPayments": [
      {
        "AcctNo": "1111",
        "CardHolder": "JOHN DOE",
        "CardType": "VI",
        "ConsentID": 6,
        "ConsentType": "S",
        "ErrMsg": "",
        "IsPartialApproval": false,
        "MerchID": 1,
        "PaymentAmt": 10,
        "PaymentDate": "2024-12-01 11:19:01",
        "PaymentNum": 1,
        "SEQ": "119",
        "SchedID": 1,
        "SchedNum": 1,
        "TxApproved": true,
        "TxID": 104,
        "TxnCode": "090944"
      }
    ],
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumApproved": 1,
    "NumDeclined": 0,
    "NumPartialAuths": 0,
    "NumProcessed": 1,
    "RespMsg": "Total Processed: 1 Approved: 1 Declined: 0 Partial: 0"
  }
}

PreviousReceipt NextSettlement

Last updated 4 months ago

Was this helpful?