Category links

API Links

BillPay

The CoreCard system allows the cardholders to pay the bills, add a new payee, update the details of the existing payee, and delete a payee using Bill Pay Services API. The CoreCard system provides the flexibility of One-Time payment and recurring payment.  The recurring payments can be scheduled, updated, and deleted for a Payee using Bill Pay Services API.  Also, the users can retrieve the details of the historical payments using the Bill Pay Services API. 

AddBillPayPayee

Action: POST

Endpoint: /api/AddBillPayPayee

POST /api/AddBillPayPayee

Use this API to allow the Service Consumer to add a new Payee or Transfer account for a specific subscriber.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeName

string

Mandatory

This is the name of the Payee Example: Andrew

Allowable Values:

20

PayeeNickname

string

Optional

This is the nickname for the Payee. Example: Andy

Allowable Values:

20

PhoneNumber

string

Mandatory

This is the phone number, including area code, for the Payee. This is a numeric field that will not accept hyphens. Valid Values: 0-9 Example: 9812338769

Allowable Values:

15

PhoneType

string

Mandatory

This is the type of phone number for the payee. Valid Values: Work, SMS Example :Work, SMS

Allowable Values:

10

EmailAddress

string

Optional

This is the email address of the Payee. Valid Values: A-Z, a-z, 0-9. Example: sem_pp1 @gmail.com

Allowable Values:

50

EmailType

string

Optional

This element specifies to whom the email address applies. Valid values : Prim - Primary owner(Individual subscriber) default Secd - Secondary account holder(for Individual subscriber accounts only)

Allowable Values:

10

RoutingNumber

string

Optional

This is the Bank Routing Number (ABA number) of the Individual Payee's bank (deposit) account Valid Values:0-9 Example: 0110000015

Allowable Values:

50

AccountType

string

Conditional

This is the type of funding account. Valid values are: D - Checking(default value) S - Savings Example: D, S. Condition: This field is mandatory when the 'PayeeClsf' is 'Indv'(Individual/Person)

Allowable Values:

10

NameOfAccount

string

Optional

This is the account name (given by the Cardholder User)for the default Bill Pay funding account(‘pay from account’) to be used to make payments to the specified Payee or Transfer account. Example: Andrew_123

Allowable Values:

20

P2PType

string

Optional

This is the type of communication method to be used for person-to-person Payee contact. Valid Values: SMS , Email. Example: SMS , Email.

Allowable Values:

10

PayeeClsf

string

Mandatory

This is the type of communication method to be used for person-to-person Payee contact. Valid Values: Comp(Company), Indv(Individual/Person) Example: Comp, Indv.

Allowable Values:

50

AddressModel

Optional

This model is to add address like address 1,2 state and Postal code.

CategoryId

Int32

Optional

This is the name of the category assigned to the Payee or Transfer account Valid Values:0-9 Example: 2

PayeeAccountNumber

string

Mandatory

This is the individual Payee's bank account number. Valid Values:0-9 Example: 1122345678

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "::1",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "PayeeName": "John smith",
  "PayeeNickname": "JS",
  "PhoneNumber": "8895642536",
  "PhoneType": "work",
  "EmailAddress": "ravi@gmail.com",
  "EmailType": "Prim",
  "RoutingNumber": "011000206",
  "AccountType": "D",
  "NameOfAccount": "Andrew",
  "P2PType": "SMS",
  "PayeeClsf": "Indv",
  "AddressModel": {
    "AddressType": "primary",
    "Addressline1": "221 Kiely Blvd",
    "Addressline2": "64A Streets",
    "City": "Santa Clara",
    "State": "CA",
    "Postalcode": "95051"
  },
  "CategoryId": 1,
  "PayeeAccountNumber": "90000000456"
}
Response Fields Detail
Fields Description

PayeeId

Int64

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "PayeeId": 2
  }
}

AddBillPaySubscriber

Action: POST

Endpoint: /api/AddBillPaySubscriber

POST /api/AddBillPaySubscriber

Use this API to allow the service consumer to add (enrol) a new subscriber for a specific FI and product.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

DDANumber

string

Mandatory

This is the DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

Allowable Values:

19

FirstName

string

Mandatory

This represents the subscriber associated user’s first name. Valid Values: A-Z, a-z Example: Andrew

Allowable Values:

20

MiddleName

string

Optional

This represents the subscriber associated user’s middle name. Valid values: A-Z, a-z Example: Charles

Allowable Values:

20

LastName

string

Mandatory

This represents the subscriber associated user’s last name. Valid values: A-Z, a-z Example: Hudson

Allowable Values:

20

EmailAddress

string

Mandatory

This is the email address of the Payee. Valid Values: A-Z, a-z, 0-9. Example: sem_pp1 @gmail.com

Allowable Values:

50

PhoneNumber

string

Mandatory

This is the phone number, including area code, for the Payee. This is a numeric field that will not accept hyphens. Valid Values: 0-9 Example: 9812338769

Allowable Values:

15

AccountType

string

Optional

This is the type of funding account. Valid values are: D – Checking(default value) S – Savings Example: D, S. Condition: This field is mandatory when the 'PayeeClsf' is 'Indv' (Individual/Person)

Allowable Values:

10

SubscriberType

string

Mandatory

This is the subscriber type for the specified subscriber. Valid Values: Comp -Company, Indv- Individual Example: Comp, Indv.

Allowable Values:

10

CustomerId

Int64

Optional

This is the optional element represents identification that is common between the Service Provider(iPay Solutions) and Service Consumer associated with an individual subscriber. Valid Values: 0-9 Example: 4545

DateOfBirth

datetime

Optional

This is the subscriber’s date of birth. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

AddressModel

Optional

Address Model
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "DDANumber": "3216120020895",
  "FirstName": "shailab",
  "MiddleName": "raj",
  "LastName": "gupta",
  "EmailAddress": "shhailab.gupta@corecard.com",
  "PhoneNumber": "3453453453",
  "AccountType": "D",
  "SubscriberType": "Indv",
  "CustomerId": 10070010,
  "DateOfBirth": "1980-02-02T00:00:00",
  "AddressModel": {
    "AddressType": "Prim",
    "Addressline1": "1 meca way",
    "Addressline2": "1 meca way2",
    "City": "Norcross",
    "State": "GA",
    "Postalcode": "30093"
  }
}
Response Fields Detail
Fields Description

SubscriberId

Int64

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "SubscriberId": 1468203809
  }
}

BillPayOneTimePayment

Action: POST

Endpoint: /api/BillPayOneTimePayment

POST /api/BillPayOneTimePayment

Use this API to perform a one-time payment to a bill Payee.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values:0-9 Example: 20

PaymentProcessDate

datetime

Optional

This is the date when the BillpaymentSource(IPAY) initiated the payment to the subscriber system. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

PaymentDate

datetime

Mandatory

This is the date when the payment get posted to Payee. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

TransactionAmount

decimal

Mandatory

This is the amount for which one time payment shall get initiated for the Payee. Example: 10.02

PaymentComment

string

Optional

This is the comment that will be stored with the payment.

Allowable Values:

1000

Memo

string

Conditional

This is the memo to be added to a check associated with a check payment. Condition : Memo tag validation working for payee if its PayeeClassificationType is Comp and for Elec it will not show validation.

Allowable Values:

25
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PaymentProcessDate": "2021-09-28T00:00:00",
  "PaymentDate": "2021-05-10T00:00:00",
  "TransactionAmount": 20.01,
  "PaymentComment": "abcd",
  "Memo": "monthly payment"
}
Response Fields Detail
Fields Description

PaymentId

Int64

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "PaymentId": 2
  }
}

BillPayRecurringEntireSeriesPayment

Action: POST

Endpoint: /api/BillPayRecurringEntireSeriesPayment

POST /api/BillPayRecurringEntireSeriesPayment

Use this API to update the entire recurring payment series.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 120

PaymentFrequencyType

string

Mandatory

This is the payment frequency for the recurring payment or recurring Transfer series at the time the payment/Transfer was processed. Valid Values: i) Weekly - Weekly ii) TwiceMonthly - Twice Monthly iii) Monthly - Monthly iv) Every3Months - Quarterly v) Every6Months - Half Yearly vi) Annual - Annually Example: Weekly, TwiceMonthly, Every3Months, Every6Months, Annual.

Allowable Values:

50

PaymentDayOfWeek

string

Optional

This is the specified day of the week when recurring payments or Transfers will be made if the specified payment frequency is: ‘Weekly’. Valid values: Mon,Tues,Wed,Thur, Fri Example: Wed Condition: This shall be the mandatory field when PaymentFrequencyType=Weekly.

Allowable Values:

20

PaymentDayofMonth

Int32

Optional

This is the day of the month when the recurring payment or Transfer will be made .The Value 'LastBusinessDay' shall not be applicable when PaymentFrequencyType is set as TwiceMonthly. Valid Values: 1 - 31 Example: 15 Condition: i: The Value 'LastBusinessDay' shall not be applicable when PaymentFrequencyType is set as TwiceMonthly. ii: This shall be the mandatory field when PaymentFrequencyType = MOnthly, TwiceMonthly.

PaymentDayofMonthTo

Int32

Optional

This is the second day of the month when the recurring payment or Transfer will be made. Valid Values: 1 - 31. Example: 28 Condition: i.This shall be the mandatory field and will be applicable only when PaymentFrequencyType is set as TwiceMonthly. ii.This day value should be greater than 6 days with the day set in DayoftheMonth tag.

PaymentUseLastBusDay

boolean

Optional

This is the payment or Transfer should be made on the last business day of the month. Valid Values: true, false. Example: true, false. Condition: This value can be set when the PaymentFrequencyType=TwiceMonthly, Monthly, Every3Months,Every6Months, Annual.

PaymentUseLastBusDayTo

boolean

Optional

This indicates that the payment or Transfer should be made on the last business day of the month. Valid Values: true, false. Example: true, false. Condition: This value can be set when the PaymentFrequencyType=TwiceMonthly

PaymentInstruction

string

Optional

This is the payment date instruction when a recurring payment or Transfer date falls on a non-processing date (such as a weekend or holiday). Valid Values: Before, After. Example: Before, After.

Allowable Values:

20

PaymentOccurance

Int32

Optional

This is the number of remaining payment or Transfer occurrences for the recurring payment or recurring Transfer series at the time the specified payment or Transfer was processed. Valid Values: 1-9999. Example: 20

PaymentSeriesExpireDate

datetime

Optional

This is the expiration date for the recurring payment or Transfer series. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00 Condition: This field is mandatory when thePaymentSeriesFinite is set as True.

PaymentSeriesFinite

boolean

Optional

This indicates whether the payment or Transfer series is finite or ‘has no end’. Valid Values: true, false.(default) Example: true, false.

TransactionAmount

decimal

Mandatory

This is the amount for which one time payment shall get initiated for the Payee. Example:10.02

PaymentProcessDate

datetime

Mandatory

This is the date when the BillpaymentSource(IPAY) initiated the payment to the subscriber system. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

PaymentDate

datetime

Mandatory

This is the date when the payment get posted to Payee. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

ActivationIntentKey

string

Mandatory

This is the Activation key is used to Update/Delete the Payee Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

Memo

string

Optional

This is the memo to be added to a check associated with a check payment.

Allowable Values:

25

PaymentComment

string

Optional

This is the comment that will be stored with the payment.

Allowable Values:

300
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PaymentId": 1,
  "PayeeId": 1,
  "PaymentFrequencyType": "Monthly",
  "PaymentDayOfWeek": "",
  "PaymentDayofMonth": 5,
  "PaymentInstruction": "After",
  "PaymentSeriesExpireDate": "2021-11-30T00:00:00",
  "PaymentSeriesFinite": true,
  "TransactionAmount": 20.01,
  "PaymentProcessDate": "2021-09-28T00:00:00",
  "PaymentDate": "2021-05-10T00:00:00",
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6",
  "Memo": "monthly payment",
  "PaymentComment": "abcd"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

BillPayRecurringPayment

Action: POST

Endpoint: /api/BillPayRecurringPayment

POST /api/BillPayRecurringPayment

Use this API to schedule a recurring payment for a Payee.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PaymentFrequencyType

string

Mandatory

This is the payment frequency for the recurring payment or recurring Transfer series at the time the payment/Transfer was processed. Valid Values: i) Weekly - Weekly ii) TwiceMonthly - Twice Monthly iii) Monthly - Monthly iv) Every3Months - Quarterly v) Every6Months - Half Yearly vi) Annual - Annually Example: Weekly, TwiceMonthly, Every3Months, Every6Months, Annual

Allowable Values:

50

PaymentDayOfWeek

string

Conditional

This is the specified day of the week when recurring payments or Transfers will be made if the specified payment frequency is: ‘Weekly’. Valid values: Mon,Tues,Wed,Thur, Fri Example: Wed Condition: This shall be the mandatory field when PaymentFrequencyType=Weekly.

Allowable Values:

20

PaymentDayofMonth

Int32

Conditional

This is the day of the month when the recurring payment or Transfer will be made .The Value 'LastBusinessDay' shall not be applicable when PaymentFrequencyType is set as TwiceMonthly. Valid Values: 1 - 31 Example: 15 Condition: i: The Value 'LastBusinessDay' shall not be applicable when PaymentFrequencyType is set as TwiceMonthly. ii: This shall be the mandatory field when PaymentFrequencyType = MOnthly, TwiceMonthly ,Every3Months.

PaymentDayofMonthTo

Int32

Conditional

This is the second day of the month when the recurring payment or Transfer will be made. Valid Values: 1 - 31. Example: 28 Condition: i.This shall be the mandatory field and will be applicable only when PaymentFrequencyType is set as TwiceMonthly. ii.This day value should be greater than 6 days with the day set in DayoftheMonth tag.

PaymentUseLastBusDay

boolean

Conditional

This is the payment or Transfer should be made on the last business day of the month. Valid Values:true,False. Example:true,False. Condition: This value can be set when the PaymentFrequencyType=TwiceMonthly, Monthly, Every3Months,Every6Months, Annual.

PaymentUseLastBusDayTo

boolean

Conditional

This indicates that the payment or Transfer should be made on the last business day of the month. Valid Values: true, False. Example: true, False. Condition: This value can be set when the PaymentFrequencyType=TwiceMonthly.

PaymentInstruction

string

Optional

This is the payment date instruction when a recurring payment or Transfer date falls on a non-processing date (such as a weekend or holiday). Valid Values: Before, After. Example: Before, After.

Allowable Values:

20

PaymentOccurance

Int32

Optional

This is the number of remaining payment or Transfer occurrences for the recurring payment or recurring Transfer series at the time the specified payment or Transfer was processed. Valid Values: 1-9999. Example: 20

PaymentSeriesExpireDate

datetime

Conditional

This is the expiration date for the recurring payment or Transfer series. Valid Values: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00 Condition: This field is mandatory when the PaymentSeriesFinite is set as True.

PaymentSeriesFinite

boolean

Optional

This is the payment or Transfer series is finite or 'has no end'. Valid Values: true, false(default) Example: true, false.

TransactionAmount

decimal

Mandatory

This is the Transaction Amount of the final payment on a loan, which may often differ from the other payment installments on the loan. Example: 10.25.

PaymentProcessDate

datetime

Optional

This is the starting date for processing a new recurring payment. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

PaymentDate

datetime

Mandatory

This is the starting estimated arrival date (i.e., due date/Payment Date) for a new recurring payment. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

Memo

string

Optional

This is the memo to be added to a check associated with a check payment.

Allowable Values:

25

PaymentComment

string

Optional

This is the comment that will be stored with the payment.

Allowable Values:

300
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PaymentFrequencyType": "Monthly",
  "PaymentDayOfWeek": "",
  "PaymentDayofMonth": 5,
  "PaymentDayofMonthTo": 10,
  "PaymentUseLastBusDay": true,
  "PaymentUseLastBusDayTo": true,
  "PaymentInstruction": "After",
  "PaymentOccurance": 1,
  "PaymentSeriesExpireDate": "2022-03-30T00:00:00",
  "PaymentSeriesFinite": true,
  "TransactionAmount": 20.01,
  "PaymentProcessDate": "2022-03-14T00:00:00",
  "PaymentDate": "2022-03-16T00:00:00",
  "Memo": "monthly payment",
  "PaymentComment": "abcd"
}
Response Fields Detail
Fields Description

PaymentId

Int64

This is the payment ID which is generated by Bill Payment Services. Valid Values:0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "PaymentId": 2
  }
}

BilPaySchedPmtScheduleSinglePaymentOn

Action: POST

Endpoint: /api/BilPaySchedPmtScheduleSinglePaymentOn

POST /api/BilPaySchedPmtScheduleSinglePaymentOn

Use this API to change a payment for a recurring series for a specific date.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

TransactionAmount

decimal

Mandatory

This is the amount for which one time payment shall get initiated for the Payee. Example: 10.25.

PaymentProcessDate

datetime

Mandatory

This is the date when the BillpaymentSource(IPAY) initiated the payment to the subscriber system. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

PaymentDate

datetime

Mandatory

This is the date when the payment get posted to Payee. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBilPaySchedPayment). Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

FutureScheduleID

string

Mandatory

This is specified payment Id which is user want to update in the recurring payment or recurring Transfer series. Format: MM-DD-YYYY Example: 10-10-1980

Allowable Values:

10

Memo

string

Optional

This is the memo to be added to a check associated with a check payment.

Allowable Values:

25

PaymentComment

string

Optional

This is the comment that will be stored with the payment.

Allowable Values:

300
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PaymentId": 1,
  "PayeeId": 1,
  "TransactionAmount": 20.01,
  "PaymentProcessDate": "2021-09-28T00:00:00",
  "PaymentDate": "2021-05-10T00:00:00",
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6",
  "FutureScheduleID": "03/03/2022",
  "Memo": "monthly payment",
  "PaymentComment": "abcd"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

DeleteBillPayOneTimePayment

Action: POST

Endpoint: /api/DeleteBillPayOneTimePayment

POST /api/DeleteBillPayOneTimePayment

Use this API to delete the onetime payment scheduled for a payee.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values:0-9 Example: 20

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values:0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBilPaySchedPayment) Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

50
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PaymentId": 2,
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

DeleteBillPayPayee

Action: POST

Endpoint: /api/DeleteBillPayPayee

POST /api/DeleteBillPayPayee

Use this API to allow the service consumer to delete the Payee or Transfer account entirely.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

ActivationIntentKey

string

Optional

This is the Activation key is used to Update/Delete the Payee Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

DeleteBillPayPayeeWithPayments

Action: POST

Endpoint: /api/DeleteBillPayPayeeWithPayments

POST /api/DeleteBillPayPayeeWithPayments

Use this API to allow the service consumer to delete the Payee or Transfer account entirely with their pending payments.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PayementIds

string

Mandatory

This is the Bill Pay Services API identifier for the scheduled payment or Transfer. Valid values:0-9 and , Example: 20,35,66

Allowable Values:

800

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBillPayPayee)

Allowable Values:

100
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PayementIds": "2",
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

DeleteBillPayRecurringPayment

Action: POST

Endpoint: /api/DeleteBillPayRecurringPayment

POST /api/DeleteBillPayRecurringPayment

Use this API is to delete the recurring payment series.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBilPaySchedPayment). Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

IsDeletePayment

boolean

Optional

This indicates a desire for immediate deletion(i.e., 'stop') of the entire recurring payment or recurring Transfer series. Valid Values: true, false(default) Example: true, false.

IsDeleteAfterNextPayment

boolean

Optional

This indicates a desire for deletion(i.e., 'stop') of the specified recurring payment or recurring Transfer series,but only after the currently scheduled payment or Transfer has been processed. Valid Values: true, false(default) Example: true, false.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PaymentId": 2,
  "PayeeId": 1,
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6",
  "IsDeletePayment": true,
  "IsDeleteAfterNextPayment": true
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

GetBillPayPayee

Action: POST

Endpoint: /api/GetBillPayPayee

POST /api/GetBillPayPayee

Use this API to return all Payees and Transfer accounts for a particular product and subscriber.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

IsDetailInfo

boolean

Optional

This is the decision flag to fetch detail information from IPAY or not. Valid values: true, false. Example: true, false.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "IsDetailInfo": true
}
Response Fields Detail
Fields Description

BillPayPayeeList

array

This is the List of the Payees.

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "BillPayPayeeList": [
      {
        "PayeeId": 1,
        "PayeeName": "JOHN SMITH",
        "PayeeNickName": "JS",
        "PayeeClassification": "Indv",
        "PayeePaymentMethod": "Elec",
        "PayeeStatus": "Act",
        "FirstAvailableProccessDate": "2021-10-22T00:00:00",
        "FirstAvailableEstimateArrivalDate": "2021-10-26T00:00:00",
        "EstimatedArrivalDay": 2,
        "AccountNumber": "90000000456",
        "RoutingNumber": "061120084",
        "LastPaymentDate": "0001-01-01T00:00:00",
        "NextScheduledPaymentDate": "2021-01-01T00:00:00",
        "LastPaymentAmount": 10.2,
        "SubscriberId": 1468196126,
        "PaymentID": 120,
        "CategoryId": 1
      }
    ]
  }
}

GetBillPayPaymentHistory

Action: POST

Endpoint: /api/GetBillPayPaymentHistory

POST /api/GetBillPayPaymentHistory

Use this API to get the historical payment data of the payee.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Optional

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values:0-9 Example: 20

StartDate

datetime

Optional

This is the date that designates the starting point for eBill [Due] date selections. If no Start Date is specified, the Bill Pay Services API will return all available eBills that have a Due Date that is less than the specified End Date. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

EndDate

datetime

Optional

This is the date that designates the ending point for eBill [Due] date selections. If no End Date is specified, the Bill Pay Services API will return all available eBills that have a Due Date that is greater than the specified Start Date. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

MaxRecord

Int32

Optional

This is the maximum number of records to return in the response. If no number, or an invalid number, is provided in the search request,the Service Provider(iPay Solutions) will default this value to 50, and return a maximum of 50 records in the response. Example: 10,20,50.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "::1",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "PayeeId": 1,
  "StartDate": "2021-11-25T00:00:00",
  "EndDate": "2021-11-30T00:00:00",
  "MaxRecord": 1
}
Response Fields Detail
Fields Description

BillPayPaymentList

array

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "BillPayPaymentList": [
      {
        "PaymentId": 1,
        "PayeeId": 1,
        "PayeeName": "JOHN SMITH",
        "PayeeNickName": "JS",
        "CategoryId": 1,
        "PaymentProccessDate": "2021-12-08T00:00:00",
        "PaymentDate": "2021-12-10T00:00:00",
        "TransactionAmount": 20.0,
        "PaymentStatus": "Sched",
        "PaymentMethod": "Elec",
        "PaymentFrequencyType": "Once",
        "PaymentFrequencyValue": "Once",
        "P2PType": "false",
        "PaymentIntentType": "PayBill",
        "ISeBill": "false"
      }
    ]
  }
}

GetBillPaySchedPayment

Action: POST

Endpoint: /api/GetBillPaySchedPayment

POST /api/GetBillPaySchedPayment

Use this API to retrieve the scheduled payments.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Optional

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

StartDate

datetime

Optional

This is the date that designates the starting point for eBill[Due] date selections. If no Start Date is specified, the Bill Pay Services API will return all available eBills that have a Due Date that is less than the specified End Date. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

EndDate

datetime

Optional

This is the date that designates the ending point for eBill[Due] date selections. If no End Date is specified, the Bill Pay Services API will return all available eBills that have a Due Date that is greater than the specified Start Date. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

MaxRecord

Int32

Optional

This is the maximum number of records to return in the response. If no number, or an invalid number, is provided in the search request, the Service Provider(iPay Solutions) will default this value to 50, and return a maximum of 50 records in the response. Example: 10,20,50.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "::1",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "PayeeId": 1,
  "StartDate": "2021-11-25T00:00:00",
  "EndDate": "2021-11-30T00:00:00",
  "MaxRecord": 1
}
Response Fields Detail
Fields Description

BillPayPaymentList

array

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "BillPayPaymentList": [
      {
        "PaymentId": 1,
        "PayeeId": 1,
        "PayeeName": "JOHN SMITH",
        "PayeeNickName": "JS",
        "CategoryId": 1,
        "PaymentProccessDate": "2021-12-08T00:00:00",
        "PaymentDate": "2021-12-10T00:00:00",
        "TransactionAmount": 20.0,
        "PaymentStatus": "Sched",
        "PaymentMethod": "Elec",
        "PaymentFrequencyType": "Once",
        "PaymentFrequencyValue": "Once",
        "P2PType": "false",
        "PaymentIntentType": "PayBill",
        "ISeBill": "false"
      }
    ]
  }
}

GetBillPaySubscriber

Action: POST

Endpoint: /api/GetBillPaySubscriber

POST /api/GetBillPaySubscriber

Use this API to retrieve bill pay subscriber ID by providing DDA number.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

DDANumber

string

Mandatory

This is the DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "DDANumber": "3216120020895"
}
Response Fields Detail
Fields Description

SubscriberId

Int64

This is the Service Provider's (iPay Solutions) identifier for them Cardholder User. Example : 12345678

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "SubscriberId": 1468196126
  }
}

InquiryBillPayChannel

Action: POST

Endpoint: /api/InquiryBillPayChannel

POST /api/InquiryBillPayChannel

Use this API to get bill pay channels and reference information belonging to a specific financial institution.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "::1",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": ""
}
Response Fields Detail
Fields Description

BillPayChannelInqResponseXML

string

This is a package of product and other reference information for the specified FI. Example: Return the list of non processing dates etc.

Allowable Values:

8000

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "BillPayChannelInqResponseXML": "<BilPayChanInqResponse><MsgRsHdr><jXchangeHdr xmlns=\"http://jackhenry.com/jxchange/TPG/2008\"><JxVer>R2017.4</JxVer><AuditUsrId>AuditWsId</AuditUsrId><AuditWsId /><Ver_1 /><jXLogTrackingId>84d54266-8e75-4b9c-b2c8-ad2e47023294</jXLogTrackingId><Ver_2 /><InstRtId>061120084</InstRtId><InstEnv>TEST</InstEnv><Ver_3 /><BusCorrelId>f60e1d40-7b6c-415d-9cac-fe3c0df4a863</BusCorrelId><Ver_4 /><Ver_5 /><ValidConsmName>CoreCard</ValidConsmName><ValidConsmProd>PrePaidModules</ValidConsmProd></jXchangeHdr></MsgRsHdr></BilPayChanInqResponse>"
  }
}

InquiryBillPayPayee

Action: POST

Endpoint: /api/InquiryBillPayPayee

POST /api/InquiryBillPayPayee

Use this API to return element details for a specific Payee or Transfer account for a given subscriber.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "PayeeId": 1
}
Response Fields Detail
Fields Description

SubscriberId

Int64

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PayeeName

string

This is the name of the Payee Example: Andrew

Allowable Values:

50

PayeeNickname

string

This is the nickname for the Payee. Example: Andy

Allowable Values:

50

PhoneNumber

string

This is the phone number, including area code, for the Payee. This is a numeric field that will not accept hyphens. Valid Values: 0-9 Example: 9812338769

Allowable Values:

15

PhoneType

string

This is the type of phone number for the payee. Valid Values: Work, SMS Example :Work, SMS

Allowable Values:

10

RoutingNumber

string

This is the Bank Routing Number (ABA number) of the Individual Payee's bank (deposit) account Valid Values:0-9 Example: 0110000015

Allowable Values:

50

AccountNumber

string

This is the individual Payee's bank account number. Valid Values:0-9 Example: 3002151478

Allowable Values:

50

AccountType

string

This is the type of funding account. Valid values are: D – Checking(default value) S – Savings Example: D, S. Condition: This field is mandatory when the 'PayeeClsf' is 'Indv' (Individual/Person)

Allowable Values:

10

NameOfAccount

string

This is the account name (given by the Cardholder User) for the default Bill Pay funding account(‘pay from account’) to be used to make payments to the specified Payee or Transfer account. Example: Andrew_123

Allowable Values:

20

P2PType

string

This is the type of communication method to be used for person-to-person Payee contact. Valid Values: SMS , Email. Example: SMS , Email.

Allowable Values:

10

PayeeClsf

string

This is the type of communication method to be used for person-to-person Payee contact. Valid Values: Comp(Company), Indv(Individual/Person) Example: Comp, Indv.

Allowable Values:

50

AddressModel

This model is to add address like address 1,2 state and Postal code.

ActivationIntentKey

string

This is the Activation key is used to Update/Delete the Payee Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

PayeeStaus

string

This is the status of the Payee or Transfer account. Valid Values: Act- Activated(payments can be scheduled and processed for this payee) NotAct- Not activated(pending; payments cannot be scheduled) Dlt- Deleted(payee is not available for scheduling payments) Example: Act, NotAct, Dlt.

Allowable Values:

10

EstimatedArrivalDay

Int32

This is the number of transit days required for a check payment to be delivered to this Payee. This is affected by the Payee's payment method and ZIP Code, as well as applicable Non-Processing Days. This value is added to the First Available Process Date to determine an Estimated Arrival Date. Example : 2, 5, 7, etc.

CategoryId

Int32

This is the name of the category assigned to the Payee or Transfer account Valid Values:0-9 Example: 2

PayeePmtMethodType

string

This is the payment method for the Payee associated with the processed payment or Transfer. Valid Values: Chk - Check Elec - Electronic Example: Chk, Elec.

Allowable Values:

10

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "SubscriberId": 1468196126,
    "PayeeId": 1,
    "PayeeName": "JOHN SMITH",
    "PayeeNickname": "JS",
    "PhoneNumber": "8895642536",
    "PhoneType": "Work",
    "RoutingNumber": "011000206",
    "AccountNumber": "90000000456",
    "AccountType": "D",
    "NameOfAccount": "shailab gupta",
    "P2PType": "SMS",
    "PayeeClsf": "Indv",
    "AddressModel": {
      "AddressType": "Prim",
      "Addressline1": "221 Kiely Blvd",
      "Addressline2": "64A Streets",
      "City": "Santa Clara",
      "State": "CA",
      "Postalcode": "95051"
    },
    "ActivationIntentKey": "060b1847-5541-4c49-963f-797a254ac862",
    "PayeeStaus": "Act",
    "EstimatedArrivalDay": 2,
    "CategoryId": 1,
    "PayeePmtMethodType": "Elec"
  }
}

InquiryBilPaySchedPayment

Action: POST

Endpoint: /api/InquiryBilPaySchedPayment

POST /api/InquiryBilPaySchedPayment

Use this API to get details for a specific single or recurring payment or Transfer made for a given Subscriber.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PaymentId": 1
}
Response Fields Detail
Fields Description

BillPayProd

string

This is the type of iPay Solutions service being requested. Example: BillPay

Allowable Values:

10

PayeeInfo

PaymentId

string

This is the payment ID which is generated by Bill Payment Services. Valid Values:0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

Allowable Values:

0

ActivationIntent

string

This is the Service Consumer's intention for a subsequent operation for the data set included in there response. Valid Values: Upd, Dlt Example : Upd

Allowable Values:

100

OneTimePaymentProcessDate

datetime

This is the date the currently scheduled payment or Transfer is scheduled to be processed. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

OneTimePaymentDate

datetime

This is the Estimated Arrival Date (i.e. ‘Due Date’) for a single payment. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

TransactionAmount

decimal

This is the Transaction Amount of the final payment on a loan, which may often differ from the other payment installments on the loan. Example: 10.25.

PaymentComment

string

This is the comment that will be stored with the payment.

Allowable Values:

300

Memo

string

This is the memo to be added to a check associated with a check payment.

Allowable Values:

25

RecurringPaymentProcessDate

datetime

This is the starting date for processing a new recurring payment. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

RecurringPaymentDate

datetime

This is the starting estimated arrival date (i.e., due date/Payment Date) for a new recurring payment. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T00:00:00

PaymentFrequencyType

string

This is the payment frequency for a recurring payment or recurring Transfer series. Example: Weekly, Monthly etc

Allowable Values:

50

PaymentFrequencyTypeValue

string

This is the payment frequency for a recurring payment or recurring Transfer series. Example: wed etc

Allowable Values:

50

PaymentDayOfWeek

string

This is the specified day of the week when recurring payments or Transfers will be made if the specified payment frequency is: ‘Weekly’. Example: Wed

Allowable Values:

50

PaymentInstruction

string

This is the payment date instruction when a recurring payment or Transfer date falls on a non-processing date (such as a weekend or holiday). Example: Before , After.

Allowable Values:

10

PaymentOccurence

Int32

This is the number of remaining payment or Transfer occurrences for the recurring payment or recurring Transfer series at the time the specified payment or Transfer was processed. Example: 20

PaymentSeriesExpiryDate

datetime

This is the expiration date for the recurring payment or Transfer series. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

PaymentSeriesFinite

boolean

This is the payment or Transfer series is finite or 'has no end'. Valid Values: true, false(default) Example: true, false.

RecurringTransactionAmount

decimal

This is the Transaction Amount of the final payment on a loan, which may often differ from the other payment installments on the loan. Example: 10.25.

PaymentCreditDate

datetime

This is the date the payment or Transfer was created by the Subscriber. Format : YYYY-MM-DDTHH:mm:ss Example :2015-12-11T00:00:00

PaymentIntentType

string

This represents the payment intention for the Payment(s) or Transfer(s). Valid Value - PayBill , Payment for a bill (default) Example: PayBill

Allowable Values:

10

PaymentStatus

string

The status of the payment or Transfer Sched – Scheduled Pend – Pending PendSkip - Pending Skip PmtApprvReq - Payment Approval Required Example: Sched

Allowable Values:

50

PaymentMethod

string

This is the payment method for the Payee or Transfer account associated with the scheduled payment or Transfer. Example: Chk, Elec.

Allowable Values:

10

FrequencyOn

string

This is the On Date (Used for all frequencies except weekly and twice monthly)

Allowable Values:

3

FrequencyAnd

string

This is the And date (Used for twice monthly frequency)

Allowable Values:

3

ActivationIntentKey

string

This is the Activation key used for Update/Delete the shedule payment. Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

FuturePayment

array

Future Payment

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {
    "BillPayProd": "",
    "PayeeInfo": {
      "SubscriberId": 1468203805,
      "PayeeId": 1,
      "PayeeName": "TTEST TEST",
      "PayeeNickname": "Ipaytest",
      "PhoneNumber": "9685731337",
      "PhoneType": "Work",
      "RoutingNumber": "061120084",
      "AccountNumber": "784596123",
      "AccountType": "",
      "NameOfAccount": "ttest test",
      "PayeeClsf": "Comp",
      "AddressModel": {
        "AddressType": "Prim",
        "Addressline1": "1 MECAWAY",
        "Addressline2": "",
        "City": "Norcross",
        "State": "GA",
        "Postalcode": "30093"
      },
      "CategoryId": 14582456,
      "PayeePmtMethodType": "Chk"
    },
    "PaymentId": "1",
    "ActivationIntent": "Upd",
    "OneTimePaymentProcessDate": "2021-06-17T00:00:00",
    "OneTimePaymentDate": "2021-06-17T00:00:00",
    "TransactionAmount": 11.0,
    "PaymentComment": null,
    "Memo": null,
    "RecurringPaymentProcessDate": "2021-06-10T00:00:00",
    "RecurringPaymentDate": "2021-06-17T00:00:00",
    "PaymentFrequencyType": "Monthly",
    "PaymentFrequencyTypeValue": "Monthly",
    "PaymentDayOfWeek": "",
    "PaymentInstruction": "Before",
    "PaymentOccurence": 0,
    "PaymentSeriesExpiryDate": "2021-06-24T00:00:00",
    "PaymentSeriesFinite": true,
    "RecurringTransactionAmount": 0.0,
    "PaymentCreditDate": "2021-05-28T00:00:00",
    "PaymentIntentType": "PayBill",
    "PaymentStatus": "Sched",
    "PaymentMethod": "Chk",
    "FrequencyOn": "17",
    "FrequencyAnd": "",
    "ActivationIntentKey": "e8190e75-a1b3-4867-97d3-ab4f116a5703",
    "FuturePayment": [
      {
        "FuturePaymentId": "6/17/2021 12:00:00 AM",
        "FuturePaymenStatus": "Sched",
        "FuturePaymenOriginalProcdureDt": "2021-06-17T00:00:00",
        "FuturePaymenActualProcedurecDt": "2021-10-12T00:00:00",
        "FuturePaymenAmout": 11.0
      }
    ]
  }
}

SkippedBillPayRecurringPayment

Action: POST

Endpoint: /api/SkippedBillPayRecurringPayment

POST /api/SkippedBillPayRecurringPayment

Use this API to Skip payment for a recurring series for a specific date.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values: 0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

PayeeId

Int64

Optional

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBilPaySchedPayment). Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

FutureScheduleID

string

Mandatory

This is the payment Id which user want to update in the recurring payment or recurring Transfer series. Format: MM-DD-YYYY Example: 10-10-1980

Allowable Values:

10
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203638,
  "PaymentId": 2,
  "PayeeId": 1,
  "ActivationIntentKey": "ae55a62c-63b1-41bf-be34-77607d7f8ef9",
  "FutureScheduleID": "03/02/2022"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

UpdateBillPayOneTimePayment

Action: POST

Endpoint: /api/UpdateBillPayOneTimePayment

POST /api/UpdateBillPayOneTimePayment

Use this API to update the existing onetime payment scheduled for a payee via bill pay source.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PaymentId

Int64

Mandatory

This is the payment ID which is generated by Bill Payment Services. Valid Values:0-9 Example: 120 Note : PaymentID will be generated for only recurring payments.

PaymentProcessDate

datetime

Mandatory

This is the date when the BillpaymentSource(IPAY) initiated the payment to the subscriber system. Example :2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

PaymentDate

datetime

Mandatory

This is the date when the payment get posted to Payee. Example: 2015-12-11T00:00:00 Format : YYYY-MM-DDTHH:mm:ss

TransactionAmount

decimal

Mandatory

This is the amount for which one time payment shall get initiated for the Payee. Example: 10.02

PaymentComment

string

Optional

This is the comment that will be stored with the payment.

Allowable Values:

50

ActivationIntentKey

string

Optional

This is the Activation key (which we get from API InquiryBilPaySchedPayment) Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

50

Memo

string

Optional

This is the memo to be added to a check associated with a check payment.

Allowable Values:

25
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468203805,
  "PayeeId": 1,
  "PaymentId": 2,
  "PaymentProcessDate": "2021-09-28T00:00:00",
  "PaymentDate": "2021-05-10T00:00:00",
  "TransactionAmount": 20.01,
  "PaymentComment": "abcde",
  "ActivationIntentKey": "1856df0c-3b95-4070-8263-69bf7e9415e6",
  "Memo": "check payment"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}

UpdateBillPayPayee

Action: POST

Endpoint: /api/UpdateBillPayPayee

POST /api/UpdateBillPayPayee

Use this API to allow the service consumer to update (modify) certain elements for a Subscriber’s specified Payee or Transfer account.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

SubscriberID

Int64

Mandatory

This is the Service Provider's (iPay Solutions) identifier for the Cardholder User. Example : 12345678

PayeeId

Int64

Mandatory

This is the Payee identifier associated with the Payee or Transfer account for the Bill Pay Services API. Valid Values: 0-9 Example: 20

PayeeNickname

string

Optional

This is the nickname for the Payee. Example: Andy

Allowable Values:

20

RoutingNumber

string

Optional

The Bank Routing Number (ABA number) of the Individual Payee’s bank (deposit) account Valid Values: 0-9 Example: 0110000015

Allowable Values:

50

AccountType

string

Optional

This is the type of funding account. Valid values are: D – Checking(default value) S – Savings Example: D, S.

Allowable Values:

10

ActivationIntentKey

string

Optional

This is the Activation key is used to Update/Delete the Payee Example: B6F8CC9B-7BFC-469B-BD4C-2CA520FA0A9F

Allowable Values:

100

CategoryId

Int32

Optional

The name of the category assigned to the Payee or Transfer account Valid Values:0-9 Example: 2

PayeeAccountNumber

string

Mandatory

This is the individual Payee's bank account number. Valid Values:0-9 Example: 1122345678

Allowable Values:

19

PayeeName

string

Optional

This is the name of the Payee Example: Andrew

Allowable Values:

20
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "::1",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "SubscriberID": 1468196126,
  "PayeeId": 2,
  "PayeeName": "simi",
  "PayeeNickname": "JM",
  "RoutingNumber": "",
  "AccountType": "D",
  "ActivationIntentKey": "",
  "CategoryId": 1,
  "PayeeAccountNumber": "90000000456"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "",
  "ResponseData": {}
}