Customer API

This API allows merchants to securely store customer payment and address data in the payment gateway's secure environment. Once the data is stored, merchants can tokenize the payment information and use it to process future transactions without the need for the customer to re-enter their payment information. This can help to improve the customer experience, increase customer loyalty, and reduce the risk of fraud.

Request Field Description:

Request Object:

Customer Object

Card Object

Check Object

Custom Field Object

Customer Object:

KEY	VALUE	DESCRIPTION
Customer
first_name `string`	Up to 50 Characters	First name associated with customer’s billing address.
last_name `string`	Up to 50 Characters	Last name associated with customer’s billing address.
street_1 `string`	Up to 50 Characters	The street address 1 of the customer.
street_2 `string`	Up to 50 Characters	The street address 2 of the customer.
city `string`	Up to 50 Characters	If customer has city address information, it is saved on to Nilon's system
state `string`	Up to 50 Characters	If customer has state address information, it is saved on to Nilon's system
zip `string`	5 digits or 9 digits	The postal or zip code of the cardholder.
country `string`	Up to 50 Characters	If customer has country address information, it is saved on to Nilon's system
phone_number `numeric`	10 digits	If customer has phone number contact information, it is saved on to Nilon's system
company `string`	Up to 50 characters	If customer has company contact information, it is saved on to Nilon's system
customer_id `alphanumeric`	AUTO” for auto generated id’s starts from 100000 or User Generated e.g. CID001	The customer ID is either system generated or user specific.
email `alphanumeric`	Format: [email protected]	Customer email address for any email receipt.
email_receipt `string`	1: Yes 0: No	Indicator to send email receipt to customer based on any action.
notes `string`	Transaction Notes	Customer specific notes can be provided here for additional information regarding the transactions.
action_code `numeric`	Action code 1 - Update Customer Action code 2 - Add Customer Action code 3 - Add customer/Check existing customer Action code 4 - Delete existing customer	Based on the action code, customer related updates can be performed.

Card Object:

KEY	VALUE	DESCRIPTION
number* `string`	upto 50 characters	Card number is mandatory for card based transaction
expiration_date* `numeric`	MMYY	Card Expiration Date is mandatory for card transaction
token `alphanumeric`	upto 1000 characters	Account Token generated by the gateway.
default_card `numeric`	1 - default	This account will be setup as default for the customer profile
action_code	Action code 1 - Update defined card as primary/default Action code 2 - Add a new card without setting as primary/default

Check Object:

KEY	VALUE	DESCRIPTION
aba_code* `alphanumeric`	9 digits	Routing Number specific to a ban
account_type `string`	Checking- 0, Saving- 1, Business- 2	Nature/type of bank accounts - Savings, Checking, Business
bank_name `string`	upto 255 characters	Name of the bank associated with the customer’s bank account.
check_number `string`	Up to 10 characters	Check number used while making transactions. To be provided only while using Back Office Conversions or Account Receivable Checks.
sec_code `string`	CCD- 0, PPD- 1, WEB- 2, TEL- 3, BOC- 4, ARC- 5	These are Sectional entry class codes. OnePay supports the following: CCD, PPD, WEB, TEL, BOC, ARC.
default_card `number`	1 - default	This account will be setup as default for the customer profile
token `alphanumeric`	upto 1000 characters	Account Token generated by the gateway.

Custom Field Object:

KEY	TYPE	VALUE	DESCRIPTION
id `string`	string	up to 2 Characters 1 to 20	Based on the selection on Custom User defined fields and id
value `string`	string	up to 255 Characters	Based on the selection on Custom User defined fields and values

Response Field Description

KEY	TYPE	VALUE	DESCRIPTION
result_code `numeric`	numeric	1 - Approved 2- Declined 3- Error	The overall status of the customer request.
result_text `string`	string	Up to 100 characters APPROVAL, DECLINED	The description of the customer request process.
result_sub_code `numeric`	numeric	000- Approval	Based on customer creation and data update in the onepay system, response code is sent.
transaction_datetime `numeric`	numeric	Format: yyyyMMddTHHmmss	The date and time at which the customer save or update is made.
city `string`	string	Up to 50 Characters	If customer has city address information, it is saved on to Nilon's system
state `string`	string	Up to 50 Characters	If customer has state address information, it is saved on to Nilon's system
zip `string`	string	5 digits or 9 digits	The postal or zip code of the cardholder.
country `string`	string	Up to 50 Characters	If customer has country address information, it is saved on to Nilon's system
phone_number `numeric`	numeric	10 digits	If customer has phone number contact information, it is saved on to Nilon's system
company `string`	string	Up to 50 characters	If customer has company contact information, it is saved on to Nilon's system
customer_id `alphanumeric`	alphanumeric	AUTO” for auto generated id’s starts from 100000 or User Generated e.g. CID001	The customer ID is either system generated or user specific.
email `alphanumeric`	alphanumeric	Format: [email protected]	Customer email address for any email receipt.
email_receipt `numeric`	boolean	1: Yes 0: No	Indicator to send email receipt to customer based on any action.
notes `string`	string	Transaction Notes	Customer specific notes can be provided here for additional information regarding the transactions.
action_code `numeric`	numeric	Action code 1 - Update Customer Action code 2 - Add Customer Action code 3 - Add customer/Check existing customer Action code 4 - Delete existing customer	Based on the action code, customer related updates can be performed.
Customer
first_name `string`	string	Up to 50 Characters	First name associated with customer’s billing address.
last_name `string`	string	Up to 50 Characters	Last name associated with customer’s billing address.
street_1 `string`	string	Up to 50 Characters	The street address 1 of the customer.
street_2 `string`	string	Up to 50 Characters	The street address 2 of the customer.
city `string`	string	Up to 50 Characters	If customer has city address information, it is saved on to Nilon's system
state `string`	string	Up to 50 Characters	If customer has state address information, it is saved on to Nilon's system
zip `string`	string	5 digits or 9 digits	The postal or zip code of the cardholder.
country `string`	string	Up to 50 Characters	If customer has country address information, it is saved on to Nilon's system
phone_number `numeric`	numeric	10 digits	If customer has phone number contact information, it is saved on to Nilon's system
company `string`	string	Up to 50 characters	If customer has company contact information, it is saved on to Nilon's system
customer_id `alphanumeric`	alphanumeric	AUTO” for auto generated id’s starts from 100000 or User Generated e.g. CID001	The customer ID is either system generated or user specific.
email `alphanumeric`	alphanumeric	Format: [email protected]	Customer email address for any email receipt.
email_receipt `string`	boolean	1: Yes 0: No	Indicator to send email receipt to customer based on any action.
notes `string`	string	Transaction Notes	Customer specific notes can be provided here for additional information regarding the transactions.
action_code `numeric`	numeric	Action code 1 - Update Customer Action code 2 - Add Customer Action code 3 - Add customer/Check existing customer Action code 4 - Delete existing customer	Based on the action code, customer related updates can be performed.