Payix Incorporated

2350 Airport Freeway, Suite 640

Bedford, TX 76022
www.payix.net

Payix.IO API v1.3.5 Document v5

With the Payix PCI DSS Service Provider certified Payix.IO Gateway, Clients can securely process
payments using an Application Programming Interface (API) provided by Payix. API procedures
include making one-time payments, scheduling future payments, tokenizing (encrypting) card
and ACH payment methods, and retrieving previously tokenized payment methods. Optional
parameters include payment transaction posting and collection comment integration with the
Client’s Loan Management System (LMS).

Operations:
add-card
Facilitates the submission of debit/credit card information for payment method
creation and return of a token to be used in making subsequent card payments.
add-ach (includes Canadian PAD)
Facilitates the submission of bank information for payment method creation and
return of a token to be used in making subsequent ACH payments.
all-payment-methods
Returns a list of payment methods tokens available for making a payment. Also
include payment method meta-data such as: expiration date, name of account, etc.
delete-payment-method
Allows the deletion of a payment method so that it cannot be used.
make-payment
Facilitates the submission of a payment. A confirmation number and
authorization are returned. This operation is also used for scheduling a one-time future
dated payment by setting the payment date to a future date.
refund-payment
Facilitates the refund of the full amount of a successfully made payment.
send-payment-receipt
Facilitates the sending of a receipt via email and/or SMS.
schedule-create
Facilitates create of scheduled payments
schedule-list
Returns list of schedule payments
schedule-delete
Facilitates deleting a single scheduled payment
schedule-delete-all
Facilitates deleting all recurring scheduled payments (for a recurring group or all
schedules)
schedule-edit
Facilitates editing scheduled payments

Note: channel is used to determine how the payment was taken. For example:
tel = payment taken over the phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 1

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

Headers/Authentication – required in all calls

Field Required? Max Len Description
Accept Y Submit: application/json
Content-Type Y Submit: application/x-www-form-
urlencoded
Or application/json
username Y User name assigned to client/merchant
password Y Password assigned to client/merchant

Example:
Accept:application/json
Content-Type:application/x-www-form-urlencoded
username:DemoClient
password:Password1$!

Operations Field Descriptions

add-card (POST)
Request: (Type AN = AlphaNumeric, N = Numeric, D = Date, DT = DateTime)
Field Req. Max Type Sample Description
Len Format
name Y AN John Name on card
Smith
cardNumber Y 16 N 41111111 Number on Card
11111111
cvvNumber Y 4 N 1234 CVV Number on back of card
poolId N* 11 N 18 Optional (*Required if portfolioId is
sent) Pool/Loan Group in LMS
portfolioId N* 11 N 19 Optional (*Required if poolId is
sent) Portfolio in LMS
billingZip Y 5 N 76022 Billing Zip code of card statement
expiryDate Y 7 D 10/2020 Expiration date on card
(MM/YYYY)
account Y 255 N 9999 Account or Loan Number of
cardholder in calling system for
identification and combination of
card tokens
fraudLevel N 1 N 1 0 = off or 1 = On
PostalCode is validated via AVS
Must be silo configured.
A bad match will result in
response:
{
"status": 0,
"statusCode": 201,
"message": "We are unabl
e to save your card informat
ion . Please try again.",

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 2

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

"result": {}
}

lang N 2 A ES Default is English;

To change response language,
send EN for English
For Spanish send ES
channel Y 3 A tel Source channel of the addition of
this card.
Valid values: tel = payment taken
over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field MaxLen Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

result.cardDetail Contains response fields below:
token Token for use of payments that represent the
card added at the gateway
lastFour Last four numbers of the card added
cardBrand Visa, MasterCard, Discover etc.
cardImage URL to retrieve an image of the cardBrand (png)
misc. additional fields are returned

add-ach (POST) (U.S. Customers - ACH)

Request:
Field Required? MaxLen Description
name Y Name on bank account
accountNumber Y Bank account number

routingNumber Y Bank routing (ABA) number

bankName Y Bank Name
accountType Y 1 = checking, 2 = savings
account Y Account of cardholder in calling system or
LMS for identification and combination of
tokens
lang N To change response language send EN or ES

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 3

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

channel Y Source channel of the addition of this

payment method. Valid values: tel = payment
taken over the phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App

Response: (U.S. Customers - ACH)

Field MaxLen Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

result.achDetails Contains response fields below:
token Token for use of payments that represent the card added
at the gateway
lastFour Last four numbers of the bank account added
misc. additional fields are returned

add-ach (POST) (PAD - Canadian Customers – Pre Authorized Debit)

Request:
Field Required? MaxLen Description
name Y Name on bank account
accountNumber Y Bank account number

bankNumber Y Canadian Bank Number

branchNumber Y Canadian Bank Branch Number
bankName Y Bank Name
accountType Y Required send accountType:0
account Y Account of cardholder in calling system or
LMS for identification and combination of
tokens
lang N To change response language, send EN or ES
channel Y Source channel of the addition of this
payment method. Valid values: tel = payment
taken over the phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 4

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

Response: (PAD - Canadian Customers – Pre Authorized Debit)

Field MaxLen Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

result.padDetails Contains response fields below:
token Token for use of payments that represent the card added
at the gateway
lastFour Last four numbers of the bank account added
misc. additional fields are returned

all-payment-methods (POST)
Request:
Field Required? MaxLen Description
account Y Identifies the source system account for
which the payment methods you want to
return
channel Y Source channel of the addition of this card.
Valid values: tel = payment taken over the
phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App
lang N To change response language send EN or
ES
usedOnly N 1 = Return tokens for payment methods
used successfully in ascending order. The
first returned token will be the first
payment method successfully used on that
account.

Response:
Field MaxLen Description
paymentMethods{
token The token for making a payment with this method

type 1=Card 2=ACH 3=PAD

brand ACH Bank Name or Card Brand (Visa, MasterCard
etc)
lastFour Last four of the account or card
name Name on the account or card
expDate Expiration date for cards

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 5

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

make-payment (POST)
Request:
Field Required? Note Description
token Y Token for use of payments that
represent the payment method
previously added.
amount Y Amount of payment (not
including transaction fee below)
transaction Y Additional transaction fee to be
added to the amount
account Y Account of cardholder in calling
system for identification and
combination of card tokens
paymentType Y 1=Card 2=ACH 3=PAD

paymentDate N MMDDYYYY Not Required for real time

or payments. Use for future dated
MM/DD/YYYY payments. Only use if System
Date/Time is synced with Payix
and LMS. Must be current date
or later. Future dates create a
scheduled payment
automatically.

effectiveDate N Not Required – Used posting a

alternative date to an LMS when
postPayment = 1. Only use if
System Date/Time is synced with
Payix and LMS.
postPayment Y 0 = No, 1=Yes - For system
connected/integrated
environments this will post the
payment through an API
postComment Y 0 = No, 1=Yes - For system
connected/integrated
environments this will post the
payment receipt as a comment
through an API
postPaymentMethodId Y LMS Payment Method to use for
posting. If not needed post 0
(i.e. non-integrated LMS)
poolId N* Optional (*Required if
portfolioId is sent) Used to
identify a subset of accounts,
may be used to select alternative

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 6

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

processing in the backend (i.e.

Merchant Location/Account)

portfolioId N* Optional (*Required if poolId is

sent) Used to identify a subset of
accounts, may be used to select
alternative processing in the
backend (i.e. Merchant
Location/Account)
lang N To change response language
send EN or ES
channel Y Source channel of the addition
of this card. Valid values: tel =
payment taken over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success

statusCode 200 = success

message Describes the result or error message (“Payment

successful” etc.)
Result:{

confirmId Confirmation ID, a unique ID of the payment

authorizationCode Authorization Code (In the case of Card payments

this is the Authorization from the Bank. For ACH this
is the same as the confirmId)
transactionDate The date the transaction was executed

paidAmount The total amount of the transaction

cardBrand Visa/MC etc (Card Pmt only)

bankName Bank Name entered when tokenized/added (ACH

Pmt only)
Name Name on Card or Name on Bank Account

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 7

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

postPaymentStatus 0 = false, 1= success - For system

connected/integrated environments this will post the
payment through an API
postCommentStatus 0 = false, 1= success - For system
connected/integrated environments this will post the
payment receipt as a comment through an API

send-payment-receipt (POST)
Request:
Field Required? Max Len Description
email * Email address to send receipt to (*email
OR phoneNumber required).
phoneNo * 11 Phone number to send receipt to (*email
OR phoneNumber required). Format
12223334444 or 2223334444
receiptId Y confirmId (Confirmation ID from payment)

channel Y Source channel of the addition of this card.

Valid values: tel = payment taken over the
phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success

statusCode 200 = success

Message Describes the result or error message

delete-payment-method (POST)
Request:
Field Required? Max Len Description
token Y Token that identifies the payment method
to delete
methodType Y 1=Card 2=ACH 3=PAD

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 8

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

lang N To change response language send EN or

ES
channel Y Valid values: tel = payment taken over the
phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

refund-payment (POST)
Request:
Field Required? Max Len Description
orderId Y confirmationId of the the payment to
refund
account Y Identifies the source system account for
which the payment was made
amount N For partial refunds. Note the total amount
of combined refunds cannot exceed the
total of the original payment.
postComment Y 0 = No, 1=Yes - For system
connected/integrated environments this
will post the payment receipt as a comment
through an API – Send 0 if No Integration
lang N To change response language send EN or
ES
channel Y Source channel of the addition of this card.
Valid values: tel = payment taken over the
phone
web = payment taken through a web page
ivr = interactive voice response
ios or android = Mobile App
Response:

Field Max Len Description

status 1 = success
statusCode 200 = success

message Describes the result or error message

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 9

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

schedule-create (POST)
Request:

Field Required? Max Len Description

account Y Account of cardholder in calling
system for identification and
combination of card tokens
token Y Token of the payment method

scheduleDate1 Y For scheduling One Time, Weekly,

Monthly, and Bi-Weekly payments
First date for scheduling Semi-
Monthly payments (yyyy-mm-dd)
scheduleDate2 N Second date for scheduling Semi-
Monthly payments (yyyy-mm-dd)
amount Y Total amount of payment (including
fees unless sending separately in
convFee)
convFee N Amount of convenience fee to be
charged. This is only needed when
not included in “amount”
scheduleCount N Instead of calculating the payment,
Example: 24 will create 24 future
payments at the frequency sent in
scheFreq
paymentType Y 1 = Card, 2 = ACH, 3 = PAD

type Y 1 = One Time, 2 = Recurring

scheFreq N Weekly = WE,

Monthly = MO,
Semi-Monthly = SM,
Bi-Weekly = BW
lang N To change response language send
EN or ES
channel Y Source channel of the addition of
this card. Valid values: tel = payment
taken over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App
Response:

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 10

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

Field Max Len Description

status 1 = success
statusCode 200 = success

message Describes the result or error message

result "data": {
"id": 29479,
"scheduledRecurringGroupId": null,
"loanId": 11,
"pmtAmt": 55.56,
"nextExecutionDate": {
"date": "2018-12-01 00:00:00.000000",
"timezoneType": 3,
"timezone": "UTC"
},
"executionDate": null,
"repeatingTimes": 0,
"cardMethodId": 9,
"achMethodId": null,
"status": "0",
"type": "1",
"createdAt": {
"date": "2018-12-26 16:15:35.000000",
"timezoneType": 3,
"timezone": "UTC"
},
"pmtFrequency": "",
"loanTerm": 1,
"achMethod": null,
"cardMethod": {
[DETAILS]
},
"loan": {
"id": 11,
"loanNo": "CT017-10010",
[DETAILS]
},
"repeatingType": "One Time",
"paymentText": "Only Once",
"paymentType": 1
}

schedule-list (POST)
Request:

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 11

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

Field Required? Max Len Description

account Y Account of cardholder in calling
system for identification and
combination of card tokens
limit Y limit records pulled

offset Y Starting record – set to 0 for all

type N Empty = All, 0 = Scheduled, 1 =

Successful, 2 =Failed, 3 = Deleted
sortBy N 1 = Next Execution Date: Ascending
- Default,
2 = Next Execution Date:
Descending,
3 = Payment Amount: Ascending,
4 = Payment Amount Descending
lang N To change response language send
EN or ES
channel Y Source channel of the addition of
this card. Valid values: tel = payment
taken over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success

statusCode 200 = success

message Describes the result or error message

result Example Result:

"id": 4569,
"loanId": 54,
"pmtAmt": 55,
"nextExecutionDate": {
"date": "2018-12-01",
"timezoneType": 3,
"timezone": "UTC"
},
"repeatingTimes": 0,
"cardMethodId": 9,
"achMethodId": null,

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 12

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

"status": "1",
"type": "1",
"createdAt": {
"date": "2018-11-21",
"timezoneType": 3,
"timezone": "UTC"
},
"deletedAt": null,
"cardMethod": {},
"isSchedule": 0,
"cardTransactionFee": 0,
"paymentType": 1
},
"achMethod": null,
"paymentText": "Only Once",

schedule-delete (POST)
Request:
Field Required? Max Len Description

account Y Account of cardholder in calling

system for identification and
combination of card tokens
scheduleId Y Id of scheduled payment

lang N To change response language send

EN or ES
channel Y Source channel of the addition of
this card. Valid values: tel =
payment taken over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

result Gives schedule payment info and loan details

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 13

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

schedule-delete-all (POST)
Request:
Field Required? Max Len Description

account Y Account of cardholder in calling

system for identification and
combination of card tokens
recurringId N Id of the recurring schedule
payments – if this is not sent it will
delete all recurring schedules on
the account
lang N To change response language send
EN or ES
channel Y Source channel of the addition of
this card. Valid values: tel =
payment taken over the phone
web = payment taken through a
web page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Len Description
status 1 = success
statusCode 200 = success

message Describes the result or error message

schedule-edit (POST)
Request:
Field Required? Max Description
Len
account Y Account of cardholder in calling
system for identification and
combination of card tokens
scheduleId Y Id of scheduled payment

loanAmount Y New amount for schedule

recurringEdit N To apply changes to entire recurring

schedule send 1, to only apply to the
single scheduled payment send 0

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 14

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

convFee N Amount of convenience fee to be

charged. This is only needed when
not included in “amount”
scheduleDate1 Y Scheduled payment date

paymentType Y 1=Card 2=ACH 3=PAD

token N Token of the payment method

lang N To change response language send

EN or ES
channel Y Source channel of the addition of this
card. Valid values: tel = payment
taken over the phone
web = payment taken through a web
page
ivr = interactive voice response
ios or android = Mobile App

Response:
Field Max Description
Len
status 1 = success
statusCode 200 = success

message Describes the result or error message

result Gives schedule payment info and loan details

Adding a card using i-frame:

Payix has a PCI-DSS compatible way for clients
to created payment methods (card/ACH
tokens). Using a client specific Payix provided
URL, clients can pass an account number in
the query string to “pop” a web based i-frame
window.
e.g. /web/nls/create-payment-
token?account=4010

Returns a blank page with the response in

meta tags:

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 15

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED
 Payix Incorporated
2350 Airport Freeway, Suite 640
Bedford, TX 76022
www.payix.net

<meta Status="true" Token="5a035db5a26e61111" LastFourDigits="1111"

ExpiryDate="02/2018" NameOnCard="adsf" BillingZip="76063">

CONFIDENTIAL INTERNAL DOCUMENT NOT TO BE REPRODUCED OR DISTRIBUTED pg. 16

COPYRIGHT© PAYIX INCORPORATED ALL RIGHTS RESERVED