Online Payments

Send Verification Email

Sends a verification code for email validation

SecurityJWT
Request
Request Body schema:
email
string

Email address to which the verification code will be sent.

Responses
200

Success

400

Bad Request, Invalid Parameters

403

Forbidden

404

Not Found

500

Internal Server Error

post/cw/onlinepayments/verificationcode/email
Request samples
{ }
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}

Schedule Payment Confirmation Email API

Sends an email with the confirmation for a schedule payment.

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

paymentScheduleId
integer <int32>

Defines the payment schedule id

busUnitId
integer <int32>

ID of the business unit that owns this

loginId
integer <int32>

Defines the login id

required
object (Instrument)

Defines the instrument

required
object (AccountLink)

Defines the account link

schedPmtName
string

Defines the payment name

paymentScheduleType
required
string

Defines the payment schedule type

Enum: "ONE_TIME" "RECURRING"
scheduleFrequency
string

Defines the schedule frequency

Enum: "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" "WEEKLY" "SEMI_ANNUALLY" "SEMI_MONTHLY"
payAmountDue
required
boolean

Defines whether to pay the amount due or a specific amount.

scheduleStartDate
string <date-time>

Defines the schedule start date

scheduleEndDate
string <date-time>

Defines the schedule end date

paymentDate
string <date-time>

Defines the next payment date

paymentAmount
number

Defines the payment amount when payAmountDue is false

paymentGeneratedFrom
string

Defines the portal where the schedule payment is coming from CONSUMER or MERCHANT.

Enum: "CONSUMER" "MERCHANT"
scheduleCreatedDate
string <date-time>

Date the payment schedule was created

scheduleModifiedDate
string <date-time>

Last Date the payment schedule was modified

email
string

Email address to be notified when this payment schedule has activity

paymentCreated
boolean

Payment is currently being scheduled and cannot be updated

appliedPaymentType
string

Defines the selected applied payment type for loan payment

Responses
200

Success

400

Bad Request, Invalid Parameters

403

Forbidden

500

Internal Server Error

post/cw/onlinepayments/payments/confirm
Request samples
{
  • "instrument": {
    },
  • "accountLink": { },
  • "paymentScheduleType": "ONE_TIME",
  • "payAmountDue": true
}
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}

Delete Schedule Payment

Deletes the payment schedule for a specific payment

SecurityJWT
Request
path Parameters
scheduledPaymentId
required
integer <int32>
Responses
200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

delete/cw/onlinepayments/payments/{scheduledPaymentId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "paymentScheduleId": 0,
  • "busUnitId": 0,
  • "loginId": 0,
  • "instrument": {
    },
  • "accountLink": {
    },
  • "schedPmtName": "string",
  • "paymentScheduleType": "ONE_TIME",
  • "scheduleFrequency": "BI_WEEKLY",
  • "payAmountDue": true,
  • "scheduleStartDate": "2023/07/08 13:04:48.145X",
  • "scheduleEndDate": "2023/07/08 13:04:48.145X",
  • "paymentDate": "2023/07/08",
  • "paymentAmount": 0,
  • "paymentGeneratedFrom": "CONSUMER",
  • "scheduleCreatedDate": "2019-08-24T14:15:22Z",
  • "scheduleModifiedDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "paymentCreated": true,
  • "appliedPaymentType": "string"
}
Get a new Payment Scheduled
Retrieves detailed information about a specific payment.


SecurityJWT 
Request 
path Parameters
scheduledPaymentId
required
integer <int32> 
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/payments/{scheduledPaymentId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "paymentScheduleId": 0,
  • "busUnitId": 0,
  • "loginId": 0,
  • "instrument": {
    },
  • "accountLink": {
    },
  • "schedPmtName": "string",
  • "paymentScheduleType": "ONE_TIME",
  • "scheduleFrequency": "BI_WEEKLY",
  • "payAmountDue": true,
  • "scheduleStartDate": "2023/07/08 13:04:48.145X",
  • "scheduleEndDate": "2023/07/08 13:04:48.145X",
  • "paymentDate": "2023/07/08",
  • "paymentAmount": 0,
  • "paymentGeneratedFrom": "CONSUMER",
  • "scheduleCreatedDate": "2019-08-24T14:15:22Z",
  • "scheduleModifiedDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "paymentCreated": true,
  • "appliedPaymentType": "string"
}
Reset the Login Account Password
Resets the password for an online payments login account.


SecurityJWT 
Request 
Request Body schema: 
email
required
string
Email address associated with the account for which the password needs to be reset.


 
password
required
string
New password to set for the account.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/cw/onlinepayments/resetpassword
Request samples 
{
  • "email": "string",
  • "password": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Validates  Verification Code
The Validate Verification Code API is designed to validate a verification code submitted by a user within the Online Payments system.


SecurityJWT 
Request 
Request Body schema: 
verificationCode
required
string
Verification code to be validated.


 
email
required
string
Email address to which the verification code will be sent.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/cw/onlinepayments/verificationcode/validate
Request samples 
{
  • "verificationCode": "string",
  • "email": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get web payment terms
Retrieves the web payment terms for a specific business id.


SecurityJWT 
Request 
path Parameters
busUnitId
required
string
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/webPaymentTerms/{busUnitId}
Request samples 
Response samples 
{
  • "onlinePaymentTypes": [
    ],
  • "onlinePaymentFees": [
    ],
  • "onlinePaymentLegalNotices": [
    ],
  • "onlinePaymentAppliedPaymentTypes": [
    ],
  • "invoiceTypeEnum": "string"
}
Get Account Details to Populate Register Form
Get the account details for online payments given the biller account, biller accountName and the biller business unit id


SecurityJWT 
Request 
Request Body schema: 
billerAccountNumber
required
string
The account biller number.


 
billerAccountName
required
string
The account biller name.


 
busUnitId
required
integer <int32> 
The account biller business unit id.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/cw/onlinepayments/account/search
Request samples 
{
  • "billerAccountNumber": "string",
  • "billerAccountName": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "busUnit": {
    },
  • "externalId": "string",
  • "depositorAccountName": "string",
  • "depositorAccountDisplayName": "string",
  • "mainAccountNumber": "3423142",
  • "altAccountNumber": "0003423142",
  • "paymentDecision": "Accept",
  • "name": "John Doe",
  • "address1": {
    },
  • "address2": {
    },
  • "address3": {
    },
  • "electronicDelivery": true,
  • "dueDate": "2023/07/08",
  • "amountDue": 295.39,
  • "pastDueDate": "2023/07/08",
  • "pastDueAmount": 1295.39,
  • "payoffAmount": 1295.39,
  • "info1": "string",
  • "info2": "string",
  • "info3": "string",
  • "info4": "string",
  • "info5": "string",
  • "info6": "string",
  • "info7": "string",
  • "info8": "string",
  • "info9": "string"
}
Get a new Payment Scheduled
Retrieves detailed information about a specific payment.


SecurityJWT 
Request 
path Parameters
scheduledPaymentId
required
integer <int32> 
 
partitionNumber
required
integer <int32> 
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/payments/audit/{scheduledPaymentId}/{partitionNumber}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "paymentScheduleId": 0,
  • "busUnitId": 0,
  • "loginId": 0,
  • "instrument": {
    },
  • "accountLink": {
    },
  • "schedPmtName": "string",
  • "paymentScheduleType": "ONE_TIME",
  • "scheduleFrequency": "BI_WEEKLY",
  • "payAmountDue": true,
  • "scheduleStartDate": "2023/07/08 13:04:48.145X",
  • "scheduleEndDate": "2023/07/08 13:04:48.145X",
  • "paymentDate": "2023/07/08",
  • "paymentAmount": 0,
  • "paymentGeneratedFrom": "CONSUMER",
  • "scheduleCreatedDate": "2019-08-24T14:15:22Z",
  • "scheduleModifiedDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "paymentCreated": true,
  • "appliedPaymentType": "string"
}
List online accounts for a particular Business Unit
List online accounts for particular Business Unit. Rows are of type APILoginAccount


SecurityJWT 
Request 
Request Body schema: 
required
Array of objects (ParameterValue) 
List of Parameters defining the criteria for an operation


 
Responses 
200
Success


500
Internal Server Error


post/cw/onlinepayments/loginAccount/list
Request samples 
{
  • "parameterList": [
    ]
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Creates a new login account
Registers a new login account for online payments.


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
loginId
integer <int32> 
ID of the user associated with this login account.


 
busUnitId
required
integer <int32> 
ID of the business unit owner of this login account.


 
busUnitName
string
Name of the business unit that will own this login account. Read only.


 
firstName
required
string
First name of the user associated with this login account.


 
lastName
required
string
Last name of the user associated with this login account.


 
phoneNumber
string
Phone number of the user associated with this login account.


 
email
required
string
Email address of the user associated with this login account.


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
password
string
Password associated with this login account. Write-only.


 
passwordExpirationInterval
integer <int32> 
Interval for password expiration in days.


 
passwordExpiryDate
string <date-time> 
Date the password will expire. Read Only.


 
preferredLanguage
string
Preferred language of the user associated with this login account.


 Enum: "SPANISH" "ENGLISH"  
acceptedUsageTerms
boolean
Indicator of whether the user has accepted the usage terms.


 
status
string
Status of the given login account.


 Enum: "ACTIVE" "INACTIVE" "PENDING_TO_VALIDATE"  
createDate
string <date-time> 
Date the login account was created. Read Only.


 
lastLoginDate
string <date-time> 
Date the user last logged on. Read Only.


 
Array of objects (AccountLink) 
List of account links owned by this login account.


 
Array of objects (Instrument) 
List of instruments owned by this login account.


 
Array of objects (PaymentSchedule) 
List of payment schedules owned by this login account.


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/cw/onlinepayments/signup
Request samples 
{
  • "busUnitId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Send  Verification Code
Sends a verification code for Login account confirmation or password reset.


SecurityJWT 
Request 
Request Body schema: 
email
required
string
Email address to which the verification code will be sent.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/cw/onlinepayments/verificationcode/send
Request samples 
{
  • "email": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get the Payments List Given a link account.
Retrieves the payments list for a specific link account..


SecurityJWT 
Request 
path Parameters
linkAccountId
required
integer <int32> 
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/payments/{linkAccountId}/list
Request samples 
Response samples 
{
  • "apiPaymentSchedules": [
    ]
}
Get Schedule Payments.
Retrieves the scheduled payments matching the query.


SecurityJWT 
Request 
Request Body schema: 
required
Array of objects (ParameterValue) 
List of Parameters defining the criteria for an operation


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


500
Internal Server Error


post/cw/onlinepayments/payments/list
Request samples 
{
  • "parameterList": [
    ]
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Update Schedule Payment
Updates the payment schedule for a specific payment. Cancels a specific payment.


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
paymentScheduleId
integer <int32> 
Defines the payment schedule id


 
busUnitId
integer <int32> 
ID of the business unit that owns this


 
loginId
integer <int32> 
Defines the login id


 
required
object (Instrument) 
Defines the instrument


 
required
object (AccountLink) 
Defines the account link


 
schedPmtName
string
Defines the payment name


 
paymentScheduleType
required
string
Defines the payment schedule type


 Enum: "ONE_TIME" "RECURRING"  
scheduleFrequency
string
Defines the schedule frequency


 Enum: "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" "WEEKLY" "SEMI_ANNUALLY" "SEMI_MONTHLY"  
payAmountDue
required
boolean
Defines whether to pay the amount due or a specific amount.


 
scheduleStartDate
string <date-time> 
Defines the schedule start date


 
scheduleEndDate
string <date-time> 
Defines the schedule end date


 
paymentDate
string <date-time> 
Defines the next payment date


 
paymentAmount
number
Defines the payment amount when payAmountDue is false


 
paymentGeneratedFrom
string
Defines the portal where the schedule payment is coming from CONSUMER or MERCHANT.


 Enum: "CONSUMER" "MERCHANT"  
scheduleCreatedDate
string <date-time> 
Date the payment schedule was created


 
scheduleModifiedDate
string <date-time> 
Last Date the payment schedule was modified


 
email
string
Email address to be notified when this payment schedule has activity


 
paymentCreated
boolean
Payment is currently being scheduled and cannot be updated


 
appliedPaymentType
string
Defines the selected applied payment type for loan payment


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


put/cw/onlinepayments/payments
Request samples 
{
  • "instrument": {
    },
  • "accountLink": { },
  • "paymentScheduleType": "ONE_TIME",
  • "payAmountDue": true
}
Response samples 
{
  • "busUnit": {
    },
  • "paymentScheduleId": 0,
  • "busUnitId": 0,
  • "loginId": 0,
  • "instrument": {
    },
  • "accountLink": {
    },
  • "schedPmtName": "string",
  • "paymentScheduleType": "ONE_TIME",
  • "scheduleFrequency": "BI_WEEKLY",
  • "payAmountDue": true,
  • "scheduleStartDate": "2023/07/08 13:04:48.145X",
  • "scheduleEndDate": "2023/07/08 13:04:48.145X",
  • "paymentDate": "2023/07/08",
  • "paymentAmount": 0,
  • "paymentGeneratedFrom": "CONSUMER",
  • "scheduleCreatedDate": "2019-08-24T14:15:22Z",
  • "scheduleModifiedDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "paymentCreated": true,
  • "appliedPaymentType": "string"
}
Create a new online payment
Schedules a new payment (Guest or Register User).


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
paymentScheduleId
integer <int32> 
Defines the payment schedule id


 
busUnitId
integer <int32> 
ID of the business unit that owns this


 
loginId
integer <int32> 
Defines the login id


 
required
object (Instrument) 
Defines the instrument


 
required
object (AccountLink) 
Defines the account link


 
schedPmtName
string
Defines the payment name


 
paymentScheduleType
required
string
Defines the payment schedule type


 Enum: "ONE_TIME" "RECURRING"  
scheduleFrequency
string
Defines the schedule frequency


 Enum: "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" "WEEKLY" "SEMI_ANNUALLY" "SEMI_MONTHLY"  
payAmountDue
required
boolean
Defines whether to pay the amount due or a specific amount.


 
scheduleStartDate
string <date-time> 
Defines the schedule start date


 
scheduleEndDate
string <date-time> 
Defines the schedule end date


 
paymentDate
string <date-time> 
Defines the next payment date


 
paymentAmount
number
Defines the payment amount when payAmountDue is false


 
paymentGeneratedFrom
string
Defines the portal where the schedule payment is coming from CONSUMER or MERCHANT.


 Enum: "CONSUMER" "MERCHANT"  
scheduleCreatedDate
string <date-time> 
Date the payment schedule was created


 
scheduleModifiedDate
string <date-time> 
Last Date the payment schedule was modified


 
email
string
Email address to be notified when this payment schedule has activity


 
paymentCreated
boolean
Payment is currently being scheduled and cannot be updated


 
appliedPaymentType
string
Defines the selected applied payment type for loan payment


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/cw/onlinepayments/payments
Request samples 
{
  • "instrument": {
    },
  • "accountLink": { },
  • "paymentScheduleType": "ONE_TIME",
  • "payAmountDue": true
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Update Login Account Information
Update the login account information.


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
loginId
integer <int32> 
ID of the user associated with this login account.


 
busUnitId
required
integer <int32> 
ID of the business unit owner of this login account.


 
busUnitName
string
Name of the business unit that will own this login account. Read only.


 
firstName
required
string
First name of the user associated with this login account.


 
lastName
required
string
Last name of the user associated with this login account.


 
phoneNumber
string
Phone number of the user associated with this login account.


 
email
required
string
Email address of the user associated with this login account.


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
password
string
Password associated with this login account. Write-only.


 
passwordExpirationInterval
integer <int32> 
Interval for password expiration in days.


 
passwordExpiryDate
string <date-time> 
Date the password will expire. Read Only.


 
preferredLanguage
string
Preferred language of the user associated with this login account.


 Enum: "SPANISH" "ENGLISH"  
acceptedUsageTerms
boolean
Indicator of whether the user has accepted the usage terms.


 
status
string
Status of the given login account.


 Enum: "ACTIVE" "INACTIVE" "PENDING_TO_VALIDATE"  
createDate
string <date-time> 
Date the login account was created. Read Only.


 
lastLoginDate
string <date-time> 
Date the user last logged on. Read Only.


 
Array of objects (AccountLink) 
List of account links owned by this login account.


 
Array of objects (Instrument) 
List of instruments owned by this login account.


 
Array of objects (PaymentSchedule) 
List of payment schedules owned by this login account.


 
Responses 
200
Success


404
Not Found


500
Internal Server Error


put/cw/onlinepayments/loginAccount
Request samples 
{
  • "busUnitId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Patch Login Account Information
Patches the login account information for fields provided.


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
loginId
integer <int32> 
ID of the user associated with this login account.


 
busUnitId
required
integer <int32> 
ID of the business unit owner of this login account.


 
busUnitName
string
Name of the business unit that will own this login account. Read only.


 
firstName
required
string
First name of the user associated with this login account.


 
lastName
required
string
Last name of the user associated with this login account.


 
phoneNumber
string
Phone number of the user associated with this login account.


 
email
required
string
Email address of the user associated with this login account.


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
password
string
Password associated with this login account. Write-only.


 
passwordExpirationInterval
integer <int32> 
Interval for password expiration in days.


 
passwordExpiryDate
string <date-time> 
Date the password will expire. Read Only.


 
preferredLanguage
string
Preferred language of the user associated with this login account.


 Enum: "SPANISH" "ENGLISH"  
acceptedUsageTerms
boolean
Indicator of whether the user has accepted the usage terms.


 
status
string
Status of the given login account.


 Enum: "ACTIVE" "INACTIVE" "PENDING_TO_VALIDATE"  
createDate
string <date-time> 
Date the login account was created. Read Only.


 
lastLoginDate
string <date-time> 
Date the user last logged on. Read Only.


 
Array of objects (AccountLink) 
List of account links owned by this login account.


 
Array of objects (Instrument) 
List of instruments owned by this login account.


 
Array of objects (PaymentSchedule) 
List of payment schedules owned by this login account.


 
Responses 
200
Success


404
Not Found


500
Internal Server Error


patch/cw/onlinepayments/loginAccount
Request samples 
{
  • "busUnitId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Delete Login Account Information
Delete the login account for a specific user.


SecurityJWT 
Request 
path Parameters
loginAccountId
required
integer <int32> 
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


delete/cw/onlinepayments/loginAccount/{loginAccountId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "loginId": 0,
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "address": {
    },
  • "password": "string",
  • "passwordExpirationInterval": 0,
  • "passwordExpiryDate": "2019-08-24T14:15:22Z",
  • "preferredLanguage": "SPANISH",
  • "acceptedUsageTerms": true,
  • "status": "ACTIVE",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "accountLinks": [
    ],
  • "instruments": [
    ],
  • "paymentSchedules": [
    ]
}
Get Login Account Information
Retrieves the login account for a specific user.


SecurityJWT 
Request 
path Parameters
loginAccountId
required
integer <int32> 
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/loginAccount/{loginAccountId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "loginId": 0,
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "address": {
    },
  • "password": "string",
  • "passwordExpirationInterval": 0,
  • "passwordExpiryDate": "2019-08-24T14:15:22Z",
  • "preferredLanguage": "SPANISH",
  • "acceptedUsageTerms": true,
  • "status": "ACTIVE",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastLoginDate": "2019-08-24T14:15:22Z",
  • "accountLinks": [
    ],
  • "instruments": [
    ],
  • "paymentSchedules": [
    ]
}
Schedule Payment Confirmation Email API
Sends an email with the confirmation for a schedule payment.


SecurityNone 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
paymentScheduleId
integer <int32> 
Defines the payment schedule id


 
busUnitId
integer <int32> 
ID of the business unit that owns this


 
loginId
integer <int32> 
Defines the login id


 
required
object (Instrument) 
Defines the instrument


 
required
object (AccountLink) 
Defines the account link


 
schedPmtName
string
Defines the payment name


 
paymentScheduleType
required
string
Defines the payment schedule type


 Enum: "ONE_TIME" "RECURRING"  
scheduleFrequency
string
Defines the schedule frequency


 Enum: "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" "WEEKLY" "SEMI_ANNUALLY" "SEMI_MONTHLY"  
payAmountDue
required
boolean
Defines whether to pay the amount due or a specific amount.


 
scheduleStartDate
string <date-time> 
Defines the schedule start date


 
scheduleEndDate
string <date-time> 
Defines the schedule end date


 
paymentDate
string <date-time> 
Defines the next payment date


 
paymentAmount
number
Defines the payment amount when payAmountDue is false


 
paymentGeneratedFrom
string
Defines the portal where the schedule payment is coming from CONSUMER or MERCHANT.


 Enum: "CONSUMER" "MERCHANT"  
scheduleCreatedDate
string <date-time> 
Date the payment schedule was created


 
scheduleModifiedDate
string <date-time> 
Last Date the payment schedule was modified


 
email
string
Email address to be notified when this payment schedule has activity


 
paymentCreated
boolean
Payment is currently being scheduled and cannot be updated


 
appliedPaymentType
string
Defines the selected applied payment type for loan payment


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/public/cw/onlinepayments/payments/confirm
Request samples 
{
  • "instrument": {
    },
  • "accountLink": { },
  • "paymentScheduleType": "ONE_TIME",
  • "payAmountDue": true
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Validates  Verification Code
The Validate Verification Code API is designed to validate a verification code submitted by a user within the Online Payments system.


SecurityNone 
Request 
Request Body schema: 
verificationCode
required
string
Verification code to be validated.


 
email
required
string
Email address to which the verification code will be sent.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/public/cw/onlinepayments/verificationcode/validate
Request samples 
{
  • "verificationCode": "string",
  • "email": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get Account Details to Populate Register Form
Get the account details for online payments given the biller account, biller accountName and the biller business unit id


SecurityNone 
Request 
Request Body schema: 
billerAccountNumber
required
string
The account biller number.


 
billerAccountName
required
string
The account biller name.


 
busUnitId
required
integer <int32> 
The account biller business unit id.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/public/cw/onlinepayments/account/search
Request samples 
{
  • "billerAccountNumber": "string",
  • "billerAccountName": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "busUnit": {
    },
  • "externalId": "string",
  • "depositorAccountName": "string",
  • "depositorAccountDisplayName": "string",
  • "mainAccountNumber": "3423142",
  • "altAccountNumber": "0003423142",
  • "paymentDecision": "Accept",
  • "name": "John Doe",
  • "address1": {
    },
  • "address2": {
    },
  • "address3": {
    },
  • "electronicDelivery": true,
  • "dueDate": "2023/07/08",
  • "amountDue": 295.39,
  • "pastDueDate": "2023/07/08",
  • "pastDueAmount": 1295.39,
  • "payoffAmount": 1295.39,
  • "info1": "string",
  • "info2": "string",
  • "info3": "string",
  • "info4": "string",
  • "info5": "string",
  • "info6": "string",
  • "info7": "string",
  • "info8": "string",
  • "info9": "string"
}
Create a new online payment
Schedules a new payment (Guest or Register User).


SecurityNone 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
paymentScheduleId
integer <int32> 
Defines the payment schedule id


 
busUnitId
integer <int32> 
ID of the business unit that owns this


 
loginId
integer <int32> 
Defines the login id


 
required
object (Instrument) 
Defines the instrument


 
required
object (AccountLink) 
Defines the account link


 
schedPmtName
string
Defines the payment name


 
paymentScheduleType
required
string
Defines the payment schedule type


 Enum: "ONE_TIME" "RECURRING"  
scheduleFrequency
string
Defines the schedule frequency


 Enum: "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUALLY" "WEEKLY" "SEMI_ANNUALLY" "SEMI_MONTHLY"  
payAmountDue
required
boolean
Defines whether to pay the amount due or a specific amount.


 
scheduleStartDate
string <date-time> 
Defines the schedule start date


 
scheduleEndDate
string <date-time> 
Defines the schedule end date


 
paymentDate
string <date-time> 
Defines the next payment date


 
paymentAmount
number
Defines the payment amount when payAmountDue is false


 
paymentGeneratedFrom
string
Defines the portal where the schedule payment is coming from CONSUMER or MERCHANT.


 Enum: "CONSUMER" "MERCHANT"  
scheduleCreatedDate
string <date-time> 
Date the payment schedule was created


 
scheduleModifiedDate
string <date-time> 
Last Date the payment schedule was modified


 
email
string
Email address to be notified when this payment schedule has activity


 
paymentCreated
boolean
Payment is currently being scheduled and cannot be updated


 
appliedPaymentType
string
Defines the selected applied payment type for loan payment


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/public/cw/onlinepayments/payments
Request samples 
{
  • "instrument": {
    },
  • "accountLink": { },
  • "paymentScheduleType": "ONE_TIME",
  • "payAmountDue": true
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get web payment terms
Retrieves the web payment terms for a specific business id.


SecurityNone 
Request 
path Parameters
busUnitId
required
string
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


get/public/cw/onlinepayments/webPaymentTerms/{busUnitId}
Request samples 
Response samples 
{
  • "onlinePaymentTypes": [
    ],
  • "onlinePaymentFees": [
    ],
  • "onlinePaymentLegalNotices": [
    ],
  • "onlinePaymentAppliedPaymentTypes": [
    ],
  • "invoiceTypeEnum": "string"
}
Creates a new login account
Registers a new login account for online payments.


SecurityNone 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
loginId
integer <int32> 
ID of the user associated with this login account.


 
busUnitId
required
integer <int32> 
ID of the business unit owner of this login account.


 
busUnitName
string
Name of the business unit that will own this login account. Read only.


 
firstName
required
string
First name of the user associated with this login account.


 
lastName
required
string
Last name of the user associated with this login account.


 
phoneNumber
string
Phone number of the user associated with this login account.


 
email
required
string
Email address of the user associated with this login account.


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
password
string
Password associated with this login account. Write-only.


 
passwordExpirationInterval
integer <int32> 
Interval for password expiration in days.


 
passwordExpiryDate
string <date-time> 
Date the password will expire. Read Only.


 
preferredLanguage
string
Preferred language of the user associated with this login account.


 Enum: "SPANISH" "ENGLISH"  
acceptedUsageTerms
boolean
Indicator of whether the user has accepted the usage terms.


 
status
string
Status of the given login account.


 Enum: "ACTIVE" "INACTIVE" "PENDING_TO_VALIDATE"  
createDate
string <date-time> 
Date the login account was created. Read Only.


 
lastLoginDate
string <date-time> 
Date the user last logged on. Read Only.


 
Array of objects (AccountLink) 
List of account links owned by this login account.


 
Array of objects (Instrument) 
List of instruments owned by this login account.


 
Array of objects (PaymentSchedule) 
List of payment schedules owned by this login account.


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/public/cw/onlinepayments/signup
Request samples 
{
  • "busUnitId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Fee Calculation
Calculates the fee for an specific amount sent in the request.


SecurityNone 
Request 
Request Body schema: 
required
object (Instrument) 
Defines the instrument


 
amount
required
number
Defines the amount to calculate the fee based on the web payment term configuration


 
convenienceFee
number
Defines the convenience fee calculated given the amount


 
busUnitId
required
integer <int32> 
ID of the business unit that will own the instrument in a guest payment.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


post/public/cw/onlinepayments/payments/calculatefees
Request samples 
{
  • "instrument": {
    },
  • "amount": 0,
  • "busUnitId": 0
}
Response samples 
{
  • "instrument": {
    },
  • "amount": 0,
  • "convenienceFee": 0,
  • "busUnitId": 0,
  • "busUnit": {
    }
}
Regenerate a JWT for a service account user. Returns a JWT containing the customer account loginId claim.
SecurityNone 
Request 
Request Body schema: application/x-www-form-urlencoded
serviceAccountId
required
string
The service account's ID.


 
serviceAccountPassword
required
string
The service account's password.


 
loginId
required
integer <int32> 
The login account's unique ID.


 
Responses 
200
JWT returned as response body.


403
Bad credentials.


500
Internal Server Error


post/public/cw/onlinepayments/regenerateJwt
Request samples 
application/x-www-form-urlencoded
serviceAccountId=string&serviceAccountPassword=string&loginId=0
Authenticate a service account user and a customer account. Returns a JWT containing the customer account loginId claim.
SecurityNone 
Request 
Request Body schema: application/x-www-form-urlencoded
busUnitId
required
string
The ID of the customer account's business unit.


 
serviceAccountId
string
The service account's ID.


 
serviceAccountPassword
string
The service account's password.


 
customerAccountId
required
string
The customer account's ID.


 
customerAccountPassword
required
string
The customer account's password.


 
Responses 
200
JWT returned as response body.


403
Bad credentials.


500
Internal Server Error


post/public/cw/onlinepayments/authenticate
Request samples 
application/x-www-form-urlencoded
busUnitId=string&customerAccountId=string&customerAccountPassword=string
Send  Verification Code
Sends a verification code for Login account confirmation or password reset.


SecurityNone 
Request 
Request Body schema: 
email
required
string
Email address to which the verification code will be sent.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/public/cw/onlinepayments/verificationcode/send
Request samples 
{
  • "email": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Reset the Login Account Password
Resets the password for an online payments login account.


SecurityNone 
Request 
Request Body schema: 
email
required
string
Email address associated with the account for which the password needs to be reset.


 
password
required
string
New password to set for the account.


 
busUnitId
required
integer <int32> 
Identifier for the business unit associated with this request.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/public/cw/onlinepayments/resetpassword
Request samples 
{
  • "email": "string",
  • "password": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Update Instrument Information
Update information for a specific instrument.


SecurityJWT 
Request 
Request Body schema: 
instrumentId
required
integer <int32> 
Payment instrument ID


 
loginId
integer <int32> 
Id of Login Account owning this Account Link.


 
busUnitId
integer <int32> 
Business unit owner of this account link id.


 
nickname
string
Nick name for this instrument


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
defaultInstrument
boolean
Is this a default payment (true / false)


 
paymentType
required
string
Is this a Bank of Card instrument? Valid values are CHECK, WIRE, ACH, CREDIT_CARD, DEBIT_CARD


 
accountType
string
In case of paymentType is CHECK, valid values are Consumer, Corporate, Foreign, Travelers, Government, Money Order, Batch Ticket, Non Par


 
checkingAccountType
string
Bank account type, valid values are Checking, Savings, Loan, Gen. Lgr., CreditCard, DebitCard


 
routingNumber
string
Routing transit of the bank


 
accountNumber
string
Bank account number


 
cardNumber
string
Card number. Must be 16 digits


 
cardBrand
string
Card Brand


 
cardExpirationDate
string
Card expiry date in MM-yyyy format


 
cardCvv
string
3 or 4 digit CVV code of the card. Write-only


 
fullName
required
string
Name of the card holder or bank account holder


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
status
string
Instrument status


 Enum: "ACTIVE" "INVALID"  
Responses 
200
Success


401
Unauthorized


404
Not Found


500
Internal Server Error


503
Service Unavailable


put/cw/onlinepayments/wallet
Request samples 
{
  • "instrumentId": 0,
  • "paymentType": "string",
  • "fullName": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Creates a payment Instrument
Create a new payment Instrument for a consumer.


SecurityJWT 
Request 
Request Body schema: 
instrumentId
required
integer <int32> 
Payment instrument ID


 
loginId
integer <int32> 
Id of Login Account owning this Account Link.


 
busUnitId
integer <int32> 
Business unit owner of this account link id.


 
nickname
string
Nick name for this instrument


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
defaultInstrument
boolean
Is this a default payment (true / false)


 
paymentType
required
string
Is this a Bank of Card instrument? Valid values are CHECK, WIRE, ACH, CREDIT_CARD, DEBIT_CARD


 
accountType
string
In case of paymentType is CHECK, valid values are Consumer, Corporate, Foreign, Travelers, Government, Money Order, Batch Ticket, Non Par


 
checkingAccountType
string
Bank account type, valid values are Checking, Savings, Loan, Gen. Lgr., CreditCard, DebitCard


 
routingNumber
string
Routing transit of the bank


 
accountNumber
string
Bank account number


 
cardNumber
string
Card number. Must be 16 digits


 
cardBrand
string
Card Brand


 
cardExpirationDate
string
Card expiry date in MM-yyyy format


 
cardCvv
string
3 or 4 digit CVV code of the card. Write-only


 
fullName
required
string
Name of the card holder or bank account holder


 
object (PostalAddress) 
First Address associated with the account. Use Address Type to define the type of address


 
status
string
Instrument status


 Enum: "ACTIVE" "INVALID"  
Responses 
200
Success


401
Unauthorized


503
Service Unavailable


post/cw/onlinepayments/wallet
Request samples 
{
  • "instrumentId": 0,
  • "paymentType": "string",
  • "fullName": "string"
}
Response samples 
{
  • "instrumentId": 0,
  • "loginId": 0,
  • "busUnitId": 0,
  • "nickname": "string",
  • "busUnit": {
    },
  • "defaultInstrument": true,
  • "paymentType": "string",
  • "accountType": "string",
  • "checkingAccountType": "string",
  • "routingNumber": "string",
  • "accountNumber": "string",
  • "cardNumber": "string",
  • "cardBrand": "string",
  • "cardExpirationDate": "string",
  • "cardCvv": "string",
  • "fullName": "string",
  • "address": {
    },
  • "status": "ACTIVE"
}
View a payment instrument
Retrieve list of instrument for particular login account.


SecurityJWT 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/wallet/list
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get the Payments History
Retrieves the payment history for a specific account from  last 36 months.


SecurityJWT 
Request 
Request Body schema: 
required
Array of objects (ParameterValue) 
List of Parameters defining the criteria for an operation


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/cw/onlinepayments/payments/history
Request samples 
{
  • "parameterList": [
    ]
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Fee Calculation
Calculates the fee for an specific amount sent in the request.


SecurityJWT 
Request 
Request Body schema: 
required
object (Instrument) 
Defines the instrument


 
amount
required
number
Defines the amount to calculate the fee based on the web payment term configuration


 
convenienceFee
number
Defines the convenience fee calculated given the amount


 
busUnitId
required
integer <int32> 
ID of the business unit that will own the instrument in a guest payment.


 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


post/cw/onlinepayments/payments/calculatefees
Request samples 
{
  • "instrument": {
    },
  • "amount": 0,
  • "busUnitId": 0
}
Response samples 
{
  • "instrument": {
    },
  • "amount": 0,
  • "convenienceFee": 0,
  • "busUnitId": 0,
  • "busUnit": {
    }
}
Get List of Accounts for the merchant portal
Get the List of account details for online payments in Merchant Portal.


SecurityJWT 
Request 
Request Body schema: 
accountOrAddressOrName
required
string
The name, id or address of the customer account the user wants to search.


 
busUnitId
required
integer <int32> 
The business id of the customer account the user wants to search.


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


500
Internal Server Error


post/cw/onlinepayments/merchant/accounts
Request samples 
{
  • "accountOrAddressOrName": "string",
  • "busUnitId": 0
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Delete wallet
Delete the wallet with the given id


SecurityJWT 
Request 
path Parameters
instrumentId
required
integer <int32> 
 
Responses 
200
Success


404
Not found


500
Internal Server Error


delete/cw/onlinepayments/wallet/{instrumentId}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
View a payment instrument
Retrieve detail of a particular payment instrument.


SecurityJWT 
Request 
path Parameters
instrumentId
required
integer <int32> 
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


get/cw/onlinepayments/wallet/{instrumentId}
Request samples 
Response samples 
{
  • "instrumentId": 0,
  • "loginId": 0,
  • "busUnitId": 0,
  • "nickname": "string",
  • "busUnit": {
    },
  • "defaultInstrument": true,
  • "paymentType": "string",
  • "accountType": "string",
  • "checkingAccountType": "string",
  • "routingNumber": "string",
  • "accountNumber": "string",
  • "cardNumber": "string",
  • "cardBrand": "string",
  • "cardExpirationDate": "string",
  • "cardCvv": "string",
  • "fullName": "string",
  • "address": {
    },
  • "status": "ACTIVE"
}
➔ Next to Organization