post https://apisandbox.onepay.com/customer/
This page will help you get started with Customer.
The Create Customer request is used to add a new customer to the database with the provided details. The request typically includes information such as customer name, email address, phone number, billing address, and any other relevant details. Once the request is processed successfully, the customer's information is saved in the customer database for future reference and management.
Sample request:
{
"customer": {
"customer_id": "cust5566",
"action_code": "1"
},
"card": {
"number": "4424900930713822",
"expiration_date": "0822",
"type": "MC"
}
}
{
"customer": {
"customer_id": "AUTO",
"action_code": "1"
},
"card": {
"number": "4424900930713822",
"expiration_date": "0822",
"type": "MC"
}
}
{
"customer":
{
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "cust008",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
},
"check":
{
"aba_code":"056008849",
"account_number":"3453543455",
"account_type":"Savings",
"bank_name":"ABC Bank",
"check_number":"1234567890",
"sec_code":"PPD",
}
}
Sample Response:
{
"customer_response": {
"result_code": 1,
"result_text": "Customer Record Added",
"result_sub_code": "2000",
"transaction_datetime": "20200921T103509Z",
"token": "b65e788783424c32b487ed4a7fd3ab55",
"account_type": "VI",
"account_last_4": "3822",
"expiration_date": "0822"
},
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "cust5566",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": "1"
}
}
{
"customer_response": {
"result_code": 1,
"result_text": "Customer Record Added",
"result_sub_code": "2000",
"transaction_datetime": "20200921T103328Z",
"token": "61c714a0e0764bc5a03be0dc4de17297",
"account_type": "VI",
"account_last_4": "5541",
"expiration_date": "0822"
},
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "1000287",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": "1"
}
}
{
"customer_response": {
"result_code": 1,
"result_text": "Customer Record Added",
"result_sub_code": "2000",
"transaction_datetime": "20200921T103006Z",
"token": "cc8e553e59404e5f890cfad3c9647f2a",
"account_type": "Savings",
"account_last_4": "3455",
"expiration_date": ""
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "cust008",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
}
}
Action Code
Based on the provided action code, customer-related updates can be performed.
If no valid value is sent or an invalid value is provided, no update or addition will occur.
Action Code Description 1 Add customer - If record exists update customer(default in virtual terminal) 2 Add customer - if exists do not update 3 Add customer - if exists throw error 4 Delete customer
Sample Request:
{
"Customer": {
"action_code": "1",
"customer_id": "1000952",
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"note": "",
"custom_fields": null,
"sms_receipt": 0
},
"client_ip": "",
"card": {
"number": "372061250377282",
"expiration_date": "0329"
}
}
{
"Customer": {
"action_code": "2",
"customer_id": "AUTO",
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"note": "",
"custom_fields": null,
"sms_receipt": 0
},
"client_ip": "172.26.15.177",
"card": {
"number": "372061250377282",
"expiration_date": "0329"
}
}
{
"Customer": {
"action_code": "3",
"customer_id": "1000952",
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"note": "",
"custom_fields": null,
"sms_receipt": 0
},
"client_ip": "172.26.15.177",
"card": {
"number": "372061250377282",
"expiration_date": "0329"
}
}
{
"Customer": {
"action_code": "4",
"customer_id": "Cust12345",
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"note": "",
"custom_fields": null,
"sms_receipt": 0
},
"client_ip": "172.26.15.177",
"card": {
"Token": "3b82df2e14a8482ca4a087dbd09c1952"
// "expiration_date": "0329"
}
}
Sample Response:
{
"customer_response": {
"result_code": 1,
"result_text": "Customer Record Updated",
"result_sub_code": "2000",
"transaction_datetime": "20230518T112831Z",
"token": "6f4b9248646246c3833c019094004c00",
"account_type": "AX",
"account_last_4": "7282",
"expiration_date": "0329",
"first4": "3720"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "1000952",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"action_code": "1"
}
}
{
"customer_response": {
"result_code": 1,
"result_text": "Customer Record Added",
"result_sub_code": "2000",
"transaction_datetime": "20230518T114115Z",
"token": "6f4b9248646246c3833c019094004c00",
"account_type": "AX",
"account_last_4": "7282",
"expiration_date": "0329",
"first4": "3720"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "1000108",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"action_code": "2"
}
}
{
"customer_response": {
"result_code": 3,
"result_text": "Customer already exists",
"result_sub_code": "2004",
"transaction_datetime": "20230518T114220Z",
"token": "",
"account_type": "",
"account_last_4": "",
"expiration_date": "",
"first4": ""
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "",
"action_code": "3"
}
}
{
"customer_response": {
"result_code": 1,
"result_text": "SUCCESS",
"result_sub_code": "000",
"transaction_datetime": "20230518T114700Z",
"token": "3b82df2e14a8482ca4a087dbd09c1952",
"account_type": "",
"account_last_4": "",
"expiration_date": "",
"first4": ""
},
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "Cust12345",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
}
}