1. Introduction
The Customers API is designed for comprehensive management of customer-related data, facilitating operations across customer information, payment details, and recurring transactions. It enables users to efficiently handle a wide array of tasks including creating, updating, and retrieving customer profiles, managing payment methods and details, as well as setting up and overseeing recurring payment schedules. The following are the main operations you can do using Customers API:
Customer Management
The following methods enable you to manage customers.
GetCustomers
: Retrieve customers with various filters (GET)GetCustomerInfo
: Get specific customer information by ID (GET)Customers
: Add a new customer (POST)Customers
: Update customer details (PUT)Customers
: Delete a customer (DELETE)GetCustomersBySearchCriteria
: Search customers by criteria (GET)
Payment Details Management
The following methods enable you to manage the payment details of customers.
GetPayments
: Get credit card details (GET)GetPaymentInfo
: Get credit card details by ID (GET)PaymentDetails
: Add credit card details (POST)PaymentDetails
: update credit card details (PUT)PaymentDetails
: Delete credit card details (DELETE)GetPayments
: Get ACH payment details (GET)GetPayments
: Get ACH payment details by ID (GET)PaymentDetails
: Add ACH payment details (POST)PaymentDetails
: Update ACH payment details (PUT)PaymentDetails
: Delete ACH payment details (DELETE)PaymentDetails
: Retrieve the primary payment method for a customer (GET)
Recurring & Installment Payments
The following methods enable you to manage the recurring transactions and installments of customers.
GetRecurringTrans
: Retrieve recurring or installment transactions (GET)GetRecurringInfo
: Get specific recurring or installment transactions by ID (GET)RecurringTrans
: Add a recurring or installment transaction (POST)RecurringTrans
: Update a recurring or installment transaction (PUT)RecurringTrans
: Delete a recurring or installment transaction (DELETE)
2. Common Fields
2.1 Customer Management
The following table contains JSON fields and descriptions related to customer management using Customers API.
Name | Description | JSON Field | Value |
---|---|---|---|
Customer Number | Unique identifier for the customer | CustomerNumber | an..50 |
Phone Number | Contact phone number of the customer | PhoneNumber | int |
Email address of the customer | Email | an..50 | |
Company Name | Name of the company | CompanyName | an..50 |
First Name | First name of the customer | FirstName | an..50 |
Last Name | Last name of the customer | LastName | an..50 |
Company ID | Unique identifier for the company | CompanyId | an..50 |
Sort Expression | Field to sort the results by | SortExpression | an..20 |
Sort Direction | Direction of sorting (ASC or DESC) | SortDirection | an..20 |
Page Number | Page number for pagination | PageNumber | int |
ID | Unique identifier for the customer | Id | int |
Payment Type | Type of payment (e.g., credit, debit) | PaymentType | int |
Customer ID | Unique customer identifier | CustomerId | int |
Search Criteria | Criteria used for searching | SearchCriteria | an..50 |
2.2 Payment Details Management
The following table contains JSON fields and descriptions related to payment details management using Customers API.
Name | Description | JSON Field | Value |
---|---|---|---|
Payment Type | Identifier for the type of payment | PaymentType | Int |
Customer ID | Unique identifier associated with a customer | CustomerId | an..50 |
ID | Unique identifier for the payment record | Id | an..50 |
isPrimary | Indicates if the payment method is primary | isPrimary | int |
ExpDate | Expiration date of the payment method | ExpDate | datetime |
Address | Billing address for the payment method | Address | an..50 |
ZipCode | Zip code for the payment method | ZipCode | an..9 |
Full Name | Full name associated with the payment method | FullName | an..50 |
Card Type | Type of card, if applicable | CardType | int |
Account Number | Account number, if applicable | AccountNumber | int |
Description | Description of the payment method | Description | an..50 |
Card Number | Card number, if applicable | CardNumber | int |
Routing Number | Routing number for bank transactions | RoutingNumber | an..50 |
Account Type | Type of bank account | AccountType | int |
Bank Number | Bank identification number | BankNumber | int |
Page Size | Size of the page | PageSize | int |
Page Number | Number of pages | PageNumber | int |
2.3 Recurring & Installment Payments
The following table contains JSON fields and descriptions related to recurring payments and installments using Customers API.
Name | Description | JSON Field | Value |
---|---|---|---|
Customer ID | Unique identifier associated with a customer | CustomerId | an..20 |
Identification | Unique identifier for the transaction or item | Identification | an..50 |
Effective Date | The date when the transaction becomes effective | EffectiveDate | datetime (MM/DD/YY) |
Frequency | Frequency of the payment | Frequency | int |
Number of Payments | Total number of payments | NumberOfPayments | int |
Payment Type | Identifier for the type of payment | PaymentType | int |
Payment Info Id | Unique identifier for payment information | PaymentInfo_Id | an..50 |
Invoice Number | Unique identifier for the invoice | InvoiceNumber | an..50 |
Plan Type | Type of payment plan (1-Recurring, 2- Installment) | PlanType | int |
Unlimited | Indicates if the plan has unlimited payments | Unlimited | boolean (0 or 1) |
Recurring Amount | Amount for recurring payments | RecurringAmount | float |
Total Amount | Total amount for installment payments | TotalAmount | float |
Swipe Fee Amount | Amount charged as a service fee | SwipeFeeAmount | float |
Swipe Fee Label | Label for the service fee | SwipeFeeLabel | an..20 |
Recurring Id | Unique identifier for recurring transactions | RecurringId | an..50 |
Page Size | Size of the page | PageSize | int |
Page Number | Number of pages | PageNumber | int |
2.4 Billing and Shipping Address
The following table provides a concise overview of each field related to billing and shipping information.
Name | Description | JSON Field | Value |
---|---|---|---|
Customer Number | Unique customer identifier | CustomerNumber | an..50 |
Billing First Name | First name associated with billing | BillingFirstName | an..50 |
Billing Last Name | Last name associated with billing | BillingLastName | an..50 |
Billing Company Name | Company name associated with billing | BillingCompanyName | an..50 |
Billing Address | Address associated with billing | BillingAddress | an..100 |
Billing City | City associated with billing | BillingCity | an..50 |
Billing State | State associated with billing | BillingState | an..2 |
Billing Zip Code | Zip code associated with billing | BillingZipCode | an..9 |
Billing Country | Country associated with billing | BillingCountry | an..50 |
Billing Phone | Phone number associated with billing | BillingPhone | an..50 |
Billing Fax | Fax number associated with billing | BillingFax | an..50 |
Billing Email | Email address associated with billing | BillingEmail | an..50 |
Shipping First Name | First name associated with shipping | ShippingFirstName | an..50 |
Shipping Last Name | Last name associated with shipping | ShippingLastName | an..50 |
Shipping Company Name | Company name associated with shipping | ShippingCompanyName | an..50 |
Shipping Address | Address associated with shipping | ShippingAddress | an..100 |
Shipping City | City associated with shipping | ShippingCity | an..50 |
Shipping State | State associated with shipping | ShippingState | an..2 |
Shipping Zip Code | Zip code associated with shipping | ShippingZipCode | an..9 |
Shipping Country | Country associated with shipping | ShippingCountry | an..50 |
Shipping Phone | Phone number associated with shipping | ShippingPhone | an..50 |
Shipping Fax | Fax number associated with shipping | ShippingFax | an..50 |
Shipping Email | Email address associated with shipping | ShippingEmail | an..50 |
3. Postman Collection
Explore our comprehensive Postman Collection for the Customers API, featuring an extensive selection of requests along with successful responses.
Appendix A – Communicate with Customer API
Gateway Test Environment:
URL: https://sandbox.hipfinity.co
Gateway Production Environment:
URL: https://connect.hipfinity.co
Processing your requests with Customers API®:
Path: /apis/api/
Authentication
To authenticate requests with the Customers API, you must use Basic Authentication. This method involves using Client Key
and Client Secret
respectively as the username and password fields respectively.
Specification | Description | Example/Format |
Authentication Type | Method used for API authentication. | Basic Authentication |
Username | Identifier for the API user. | Client Key |
Password | Secret used for verifying identity. | Client Secret |
Retrieve Your Credentials
Before you can authenticate, you need to obtain your Client Key and Client Secret, which serve as your API credentials. For detailed instructions on how to retrieve these credentials, please refer to How to Retrieve Client Key and Client Secret.
Note: For Sample Code to process your requests with the Customer Test environment, please see Appendix B.
Appendix B – Sample Customer API Requests and Responses
The following are the samples for requests formatted using the JSON-based Customer Test environment. To customize your information, refer to the specification’s details in the Common Fields section.
Sending an HTTP Request
Get Customers
Request
CustomerNumber:0001
PhoneNumber:
Email:
CompanyName:
FirstName:
LastName:
CompanyId:
SortExpression:CustomerNumber
SortDirection:ASC
Response
[
{
"Id": "CFB11B68B3EE0C30C1EF7E590251D918",
"CustomerNumber": "0001000",
"BillingFirstName": "",
"BillingLastName": "",
"BillingCompanyName": "",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "",
"ShippingFirstName": "",
"ShippingLastName": "",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "",
"DateTime": "6/18/2020 4:43:18 PM",
"CompanyId": 27680,
"AccountType": 1
},
{
"Id": "8FE1820E8859262D532AD5AE3A903779",
"CustomerNumber": "201030001055101",
"BillingFirstName": "",
"BillingLastName": "",
"BillingCompanyName": "",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "",
"ShippingFirstName": "",
"ShippingLastName": "",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "",
"DateTime": "10/29/2020 8:10:55 PM",
"CompanyId": 27680,
"AccountType": 1
},
{
"Id": "95522A200AC7AD2334336BBFB9646B74",
"CustomerNumber": "201030001241346",
"BillingFirstName": "",
"BillingLastName": "",
"BillingCompanyName": "",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "",
"ShippingFirstName": "",
"ShippingLastName": "",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "",
"DateTime": "10/29/2020 8:12:41 PM",
"CompanyId": 27680,
"AccountType": 1
}
]
Get Customer Info by ID
Request
Id:3F6D23E473FD96798587868EA937ABF0
Response
{
"Id": null,
"CustomerNumber": "Kanishk",
"BillingFirstName": "Kanishk",
"BillingLastName": "Singh",
"BillingCompanyName": "",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "ksingh@hipfinity.co",
"ShippingFirstName": "Kanishk",
"ShippingLastName": "Singh",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "ksingh@hipfinity.co",
"DateTime": null,
"CompanyId": 0,
"AccountType": 0
}
Add Customer
Request
{
"CustomerNumber": "Kanishk",
"BillingFirstName": "Kanishk",
"BillingLastName": "Singh",
"BillingCompanyName": "",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "ksingh@hipfinity.co",
"ShippingFirstName": "Kanishk",
"ShippingLastName": "Singh",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "ksingh@hipfinity.co"
}
Response
{
"StatusCode": 200,
"StatusText": "3F6D23E473FD96798587868EA937ABF0"
}
Update Customer
Request
{
"Id": "76B6DF0AD4E4F40C9DFF8C117D41D4BF",
"CustomerNumber": "rasheed",
"BillingFirstName": "Rasheed",
"BillingLastName": "Almuslimani",
"BillingCompanyName": "Company",
"BillingAddress": "",
"BillingCity": "",
"BillingState": "",
"BillingZipCode": "",
"BillingCountry": "",
"BillingPhone": "",
"BillingFax": "",
"BillingEmail": "rasheed@osgpro.com",
"ShippingFirstName": "",
"ShippingLastName": "",
"ShippingCompanyName": "",
"ShippingAddress": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingZipCode": "",
"ShippingCountry": "",
"ShippingPhone": "",
"ShippingFax": "",
"ShippingEmail": "TestMail@gmail.com"
}
Response
{
"StatusCode": 200,
"StatusText": "OK"
}
Delete Customer
Request
Id:343F360F6BDF41CFF9A04F72E436FD03
Response
{
"StatusCode": 200,
"StatusText": "OK"
}
Get Customer Credit Card Details
Request
PaymentType:2
CustomerId:3F6D23E473FD96798587868EA937ABF0
PageSize:
PageNumber:
Response
[
{
"Id": "021AB5BCF68FD10FA6A2E7EB973A672F",
"CompanyId": null,
"CustomerId": "3F6D23E473FD96798587868EA937ABF0",
"isPrimary": false,
"ExpDate": "1225",
"Address": "Adress1",
"ZipCode": "12547",
"FullName": "Thami Smires",
"RoutingNumber": null,
"AccountType": null,
"AccountNumber": null,
"Description": "Desc12",
"PaymentType": null,
"CardNumber": "400300xxxx6781"
}
]
Get Customer Credit Card Details by ID
Request
PaymentType:2
Id:3FE6D05F2B397E928B013F04835257D8
Response
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"CardNumber": "549999xxxx6781",
"ExpDate": "1126",
"Description": "Desc12",
"FullName": "CustomerFullName",
"Address": "Adress1",
"ZipCode": "12547",
"isPrimary": false
}
Add Customer Credit Card Details
Request
{
"isPrimary": false,
"ExpDate": "1225",
"Address": "Adress1",
"ZipCode": "12547",
"FullName": "Thami Smires",
"CardType": null,
"Description": "Desc12",
"CustomerId": "3F6D23E473FD96798587868EA937ABF0",
"PaymentType": "2",
"CardNumber": "4003000123456781"
}
Response
{
"StatusCode": 200,
"StatusText": "021AB5BCF68FD10FA6A2E7EB973A672F"
}
Update Customer Credit Card Details
Request
{
"isPrimary": false,
"ExpDate": "1126",
"Address": "Adress1",
"ZipCode": "12547",
"FullName": "CustomerFullName",
"Id" : "8EB0FF860147A34DF26C96293B5AC7B1",
"CardType": null,
"AccountNumber": null,
"Description": "Desc12",
"CustomerId": "76B6DF0AD4E4F40C9DFF8C117D41D4BF",
"PaymentType": "2",
"CardNumber": "5499990123456781"
}
Response
{
"StatusCode": 200,
"StatusText": "OK"
}
Delete Customer Credit Card Details
Request
Id:4091C15398B6A4696E87ED8CDE3DE309
Response
{
"StatusCode": 200,
"StatusText": "Payment Method Deleted successfully!"
}
Get Customer ACH Details
Request
PaymentType:3
CustomerId:3F6D23E473FD96798587868EA937ABF0
PageSize:
PageNumber:
Response
[
{
"Id": "7F563A42860520DAD8DB1F5013F2A090",
"CompanyId": null,
"CustomerId": "3F6D23E473FD96798587868EA937ABF0",
"isPrimary": true,
"ExpDate": null,
"Address": null,
"ZipCode": null,
"FullName": "Kanishk Singh",
"RoutingNumber": "xxxx4789",
"AccountType": "0",
"AccountNumber": "xxxx3456",
"Description": "Desc2341",
"PaymentType": null,
"CardNumber": null
}
]
Get Customer ACH Details by ID
Request
PaymentType:3
Id:D3F3921D633BAEE29BC6E691ACDC2C52
Response
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"RoutingNumber": "xxxx4788",
"AccountNumber": "xxxx8742",
"Description": "Desc2341",
"FullName": "Chandrakanth",
"AccountType": "0",
"isPrimary": false
}
Add Customer ACH Details
Request
{
"RoutingNumber": "123654789",
"AccountNumber": "123456",
"AccountType": "0",
"BankNumber": "963258741",
"isPrimary": true,
"FullName": "Kanishk Singh",
"Description": "Desc2341",
"CustomerId": "3F6D23E473FD96798587868EA937ABF0",
"PaymentType": "3"
}
Response
{
"StatusCode": 200,
"StatusText": "7F563A42860520DAD8DB1F5013F2A090"
}
Update Customer ACH Details
Request
{
"RoutingNumber": "123654789",
"AccountNumber": "123456",
"AccountType": "0",
"BankNumber": "963258741",
"isPrimary": true,
"FullName": "Kanishk Singh",
"Description": "Desc2341",
"CustomerId": "3F6D23E473FD96798587868EA937ABF0",
"PaymentType": "3",
"Id" : "7F563A42860520DAD8DB1F5013F2A090"
}
Response
{
"StatusCode": 200,
"StatusText": "OK"
}
Delete Customer ACH Details
Request
Id:19B85DED3EEAA6B4CAADCF3A04F7F33F
Response
{
"StatusCode": 200,
"StatusText": "Payment Method Deleted successfully!"
}
Get Recurring or Installments
Request
EffectiveDate:
DateCreated:
Frequency:-1
CustomerNumber:12365488
CompanyName:
IdentificationNum:
Amount:
CardNumber:
InvoiceNumber:
Active:-1
Status:-1
SortExpression:
SortDirection:DESC
PageSize:
PageNumber:
Response
[
{
"RecurringID": "1B81182C8F92195177D03F37F2D474DD",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1",
"EffectiveDate": "2/28/2024 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "2",
"SwipeFeeAmount": "0.01",
"SwipeFeeLabel": "Service Fee",
"Amount": "0.11",
"Unlimited": "0",
"DateCreated": "2/25/2024 2:56:40 AM"
},
{
"RecurringID": "C851B9A8388A3998B8DDF2DC45C30DD8",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2",
"EffectiveDate": "2/28/2024 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "3",
"SwipeFeeAmount": "0.17",
"SwipeFeeLabel": "Service Fee",
"Amount": "16.84",
"Unlimited": "0",
"DateCreated": "2/25/2024 2:54:07 AM"
},
{
"RecurringID": "4EDF8E7A11D6E041DEF9E609FE14C9E2",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1",
"EffectiveDate": "12/30/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "7",
"RemainingNumberOfPayments": "1",
"PaymentType": "2",
"SwipeFeeAmount": "0.05",
"SwipeFeeLabel": "Service Fee",
"Amount": "0.2",
"Unlimited": "0",
"DateCreated": "12/20/2023 4:37:37 PM"
},
{
"RecurringID": "FB4F1EFF52216C7014111BE7B493588F",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1",
"EffectiveDate": "12/30/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "4",
"PaymentType": "2",
"SwipeFeeAmount": "0.03",
"SwipeFeeLabel": "Service Fee",
"Amount": "0.18",
"Unlimited": "0",
"DateCreated": "12/20/2023 4:22:26 PM"
},
{
"RecurringID": "37E9648B964C7412CB489BF5058EA9A8",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2",
"EffectiveDate": "12/28/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "3",
"SwipeFeeAmount": "0.25",
"SwipeFeeLabel": "Service Fee",
"Amount": "2.25",
"Unlimited": "0",
"DateCreated": "12/20/2023 4:20:21 PM"
},
{
"RecurringID": "7D57F21A1B732AD0A652959B8CEBFF3E",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2",
"EffectiveDate": "12/28/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "3",
"SwipeFeeAmount": "0.21",
"SwipeFeeLabel": "Service Fee",
"Amount": "1.88",
"Unlimited": "0",
"DateCreated": "12/20/2023 1:16:12 PM"
},
{
"RecurringID": "0D05D73A477AC505733193B0DF6AAF3E",
"CustomerNumber": "12365488",
"FullName": "CustomerFullName",
"BillingCompanyName": "Hipfinity",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1",
"EffectiveDate": "12/30/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "2",
"SwipeFeeAmount": "0.02",
"SwipeFeeLabel": "Service Fee",
"Amount": "0.13",
"Unlimited": "0",
"DateCreated": "12/20/2023 1:08:04 PM"
}
]
Get Recurring or Installments by ID
Request
Id:7D57F21A1B732AD0A652959B8CEBFF3E
Response
{
"RecurringID": "7D57F21A1B732AD0A652959B8CEBFF3E",
"CustomerNumber": "12365488",
"Identification": "DEFLT.27680.0004",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2",
"EffectiveDate": "12/28/2023 12:00:00 AM",
"Frequency": "3",
"NumberOfPayments": "6",
"RemainingNumberOfPayments": "6",
"PaymentType": "3",
"SwipeFeeAmount": "0.21",
"SwipeFeeLabel": "Service Fee",
"Amount": "1.88",
"Unlimited": "0",
"DateCreated": "12/20/2023 1:16:12 PM"
}
Add Recurring
Request
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"Identification": "DEFLT.27680.0004",
"EffectiveDate": "2/28/24",
"Frequency": "3",
"NumberOfPayments": "6",
"PaymentType": "2",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1", //(1-Recurring, 2- Installment)
"Unlimited": "0",
"RecurringAmount": "0.10",
"SwipeFeeAmount":"0.01",
"SwipeFeeLabel":"Service Fee"
}
Response
{
"StatusCode": 200,
"StatusText": "1B81182C8F92195177D03F37F2D474DD"
}
Update Recurring
Request
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"Identification": "DEFLT.27680.0004",
"EffectiveDate": "12/30/23",
"Frequency": "3",
"NumberOfPayments": "6",
"PaymentType": "2",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8521479",
"PlanType": "1", //(1-Recurring, 2- Installment)
"Unlimited": "0",
"RecurringAmount": "0.11",
"SwipeFeeAmount":"0.02",
"SwipeFeeLabel":"Service Fee",
"RecurringId": "0D05D73A477AC505733193B0DF6AAF3E"
}
Response
{
"StatusCode": 200,
"StatusText": "0D05D73A477AC505733193B0DF6AAF3E"
}
Add Installment
Request
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"Identification": "DEFLT.27680.0004",
"EffectiveDate": "2/28/24",
"Frequency": "3",
"NumberOfPayments": "6",
"PaymentType": "3",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2", //(1-Recurring, 2- Installment)
"TotalAmount": "100.00",
"SwipeFeeAmount": "0.17",
"SwipeFeeLabel":"Service Fee"
}
Response
{
"StatusCode": 200,
"StatusText": "C851B9A8388A3998B8DDF2DC45C30DD8"
}
Update Installment
Request
{
"CustomerId": "0C1495FA0D25E554B21FABBC09BE07C8",
"Identification": "DEFLT.27680.0004",
"EffectiveDate": "12/28/23",
"Frequency": "3",
"NumberOfPayments": "6",
"PaymentType": "3",
"PaymentInfo_Id": "3FE6D05F2B397E928B013F04835257D8",
"InvoiceNumber": "8547963",
"PlanType": "2", //(1-Recurring, 2- Installment)
"TotalAmount": "10.00",
"SwipeFeeAmount": "0.21",
"SwipeFeeLabel":"Service Fee",
"RecurringId": "7D57F21A1B732AD0A652959B8CEBFF3E"
}
Response
{
"StatusCode": 200,
"StatusText": "7D57F21A1B732AD0A652959B8CEBFF3E"
}
Delete Recurring or Installment
Request
Id:C2EFC385CCEBBE44876DBFDB45FC47DC
Response
{
"StatusCode": 200,
"StatusText": "OK"
}
Get Customer by Search Criteria
Request
SearchCriteria:12365489
Response
[
{
"Id": "1DAE18DF426C3EEC3C6D816489F08A9B",
"CustomerNumber": "12365489",
"BillingCompanyName": "Hipfinity",
"BillingFirstName": "ChanduFirstName",
"BillingLastName": "ChanduLastName"
}
]
Get Primary
Request
CustomerId:3F6D23E473FD96798587868EA937ABF0
PaymentType:3
Response
"7F563A42860520DAD8DB1F5013F2A090"