Company Administration Service
The Company Administration Service allows easy integration for creating, modifying, and retrieving of Companies, Locations and Groups, and their related Settings. Requests are made through POST, PUT, PATCH, GET or DELETE requests.
Authentication for the CompanyAdministrationService will be done with a Base64 encoded username:password, passed in through the BASIC HTTP Authorization Header.
Any endpoints under /companies are accessible to get or modify even if the company is INACTIVE.
Any endpoints under /locations or /groups can only be retrieved, modified or created for an ACTIVE company.
General Service Notes
POST
|
Create a new entity. |
PUT
|
Update and overwrite an existing entity. |
PATCH
|
Update portions of an existing entity. In general, fields will be updated if supplied and contain a non-null value. If supplied value is empty "", the field will be cleared. If supplied value is null, the field will not be changed.
|
GET
|
Retrieve a single entity or a list of entities. |
DELETE
|
Delete an existing entity. |
RESPONSE
|
In general, fields will only be returned if their value is not null or empty. |
Using this service, you can manage information about your company, such as a description for the company, your billing information and who gets emailed for invoices.
Company
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/companies
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/companies
PUT an updated Company which will overwrite existing values
GET a Company. This endpoint will also create a new Setting record if one does not exist
PATCH an updated Company which will overwrite existing values if not null
Request Examples
Response Example
Click to view Full Company Object
Company Object:
{
"billToCompany": {
"companyId": "2222",
"companyName": "I Will Pick Up the Tab"
},
"billing": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"autoBilling": true,
"billingCard": {
"cardToken": "thisIsAToken1234",
"expirationMonth": 12,
"expirationYear": 24
},
"billingCheck": {
"bankAccountNumber": "123456789",
"bankRoutingNumber": "987654321"
},
"invoiceBreakdownLevel": "LOCATION",
"paymentMethod": "CARD",
"username": "user@test.com"
},
"billingEmails": {
"primaryList": [
"test@test.com",
"test3@test.com"
],
"secondaryList": [
"anotherTest@test.com"
]
},
"companyId": 1234,
"serviceList": [
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"serviceAllowId": 2355,
"serviceName": "CARD",
"status": "INACTIVE",
"vendor": "USAEPAY"
},
{
"accountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"serviceAllowId": 1111,
"serviceName": "CHECK",
"status": "ACTIVE",
"vendor": "PAYLIANCE",
"vendorSettings": {
"clientId": "TESTCLIENT",
"isNachaVerifyEnabled": true
}
},
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"serviceAllowId": 1234,
"serviceName": "CARD",
"status": "DEMO",
"vendor": "PDC4U"
}
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
companyId
Numeric
|
The id of the Company.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billing
Object
|
The Billing data for this Company.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
settings
Object
|
The Settings for this Company.
NOTE: The following fields cannot be modified and are ignored if passed in: name, cardAccountDirectiveList,
achAccountDirectiveList.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billingEmails
Object
|
The billingEmails for this Company. These emails will receive an invoice each month and
also notification when the payment on the invoice has failed or been completed successfully.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serviceList
List
|
The services for this Company. This will include the data for each service that has been
configured for this company.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billToCompany
ObjectN/A
Readonly
|
Which company this company is being billed to. If this is not null, then no billing will
be returned for this company.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Company Retrieval
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/companies
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/companies
Sample Response:
{
"billToCompany": {
"companyId": "2222",
"companyName": "I Will Pick Up the Tab"
},
"billing": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"autoBilling": true,
"billingCard": {
"cardToken": "thisIsAToken1234",
"expirationMonth": 12,
"expirationYear": 24
},
"billingCheck": {
"bankAccountNumber": "123456789",
"bankRoutingNumber": "987654321"
},
"invoiceBreakdownLevel": "LOCATION",
"paymentMethod": "CARD",
"username": "user@test.com"
},
"billingEmails": {
"primaryList": [
"test@test.com",
"test3@test.com"
],
"secondaryList": [
"anotherTest@test.com"
]
},
"companyId": 1234,
"serviceList": [
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"serviceAllowId": 2355,
"serviceName": "CARD",
"status": "INACTIVE",
"vendor": "USAEPAY"
},
{
"accountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"serviceAllowId": 1111,
"serviceName": "CHECK",
"status": "ACTIVE",
"vendor": "PAYLIANCE",
"vendorSettings": {
"clientId": "TESTCLIENT",
"isNachaVerifyEnabled": true
}
},
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"serviceAllowId": 1234,
"serviceName": "CARD",
"status": "DEMO",
"vendor": "PDC4U"
}
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
Retrieve details about your company. https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/companies
–Modify your Company
PATCH :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v2_0/companies
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v2_0/companies
Sample Response:
{
"billing": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"autoBilling": true,
"billingCard": {
"cardToken": "thisIsAToken1234",
"expirationMonth": 12,
"expirationYear": 24
},
"billingCheck": {
"bankAccountNumber": "123456789",
"bankRoutingNumber": "987654321"
},
"invoiceBreakdownLevel": "LOCATION",
"paymentMethod": "CARD",
"username": "user@test.com"
},
"billingEmails": {
"primaryList": [
"test@test.com",
"test3@test.com"
],
"secondaryList": [
"anotherTest@test.com"
]
},
"companyId": 1234,
"serviceList": [
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"serviceAllowId": 2355,
"serviceName": "CARD",
"status": "INACTIVE",
"vendor": "USAEPAY"
},
{
"accountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"serviceAllowId": 1111,
"serviceName": "CHECK",
"status": "ACTIVE",
"vendor": "PAYLIANCE",
"vendorSettings": {
"clientId": "TESTCLIENT",
"isNachaVerifyEnabled": true
}
},
{
"accountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"serviceAllowId": 1234,
"serviceName": "CARD",
"status": "DEMO",
"vendor": "PDC4U"
}
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"description": "Our company is great",
"hierarchyDisplaySetting": "LOCATION",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
PATCH requests will modify only the specified parts of your company. Below are the fields and options that can be modified. Required fields cannot be set to null. The vendorSettings objects are required in full.
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billing
Object
|
You can update your company’s billing information.
Click to view the
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Attribute | Description | ||||||||||||||||
|
autoBilling
Boolean5
Required
|
Boolean to specify if Auto Billing is enabled. | ||||||||||||||||
|
paymentMethod
Alpha5
Conditional
|
The Billing Payment Method. Valid Values: CARD, CHECK.Required if autoBilling is true.
|
||||||||||||||||
|
billingCard
Object
Conditional
|
The BillingCard data.
Required for CARD paymentMethod.
|
||||||||||||||||
|
billingCheck
Object
Conditional
|
The BillingCheck data.
Required for CHECK paymentMethod.
|
||||||||||||||||
|
address
Object
|
Billing address of the company. This is specifically for the billing method.
|
||||||||||||||||
|
username
Alphanumeric60
Required
|
The name of the User performing the request. NOTE: This field is not returned in the response. |
||||||||||||||||
|
invoiceBreakdownLevel
Alpha8
|
To what level the company invoice will be broken down at the end of the billing cycle.
For example, if set to LOCATION, the invoice will show billing broken down by how much each location processed.
An empty value will default to COMPANY.
Valid Values: COMPANY, GROUP, LOCATION. |
settings
Object
Required
Settings for this Company.
NOTE: The following fields cannot be modified and are ignored if passed in: name, cardAccountDirectiveList, achAccountDirectiveList.
Click to see the Settings object
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name
Alphanumeric100
Conditional
|
The name of the group or location for which these settings apply. Required for Group and Location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
description
Alphanumeric150
|
A description of the company, group or location for which these settings apply. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
address
Object
|
Address for this location/group/company
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
receiptText
Alphanumeric5000
|
Text that will show on a receipt for transactions processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
scheduleText
Alphanumeric5000
|
Text that will show on a schedule for this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cardFeeAmount
Numeric7
|
Fee for a card transaction processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
achFeeAmount
Numeric7
|
Fee for an ach transaction processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hierarchyDisplaySetting
Enum
|
This defines whether the company, group or location name and address will display on schedules and transaction receipts. Valid Values: COMPANY, GROUP, LOCATION.There must be a group configured for the level to be GROUP.
There must be an active location configured for the level to be LOCATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cardAccountDirectiveList
ListN/A
|
List of Card AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
achAccountDirectiveList
ListN/A
|
List of ACH AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cashAccountDirectiveList
ListN/A
|
List of Cash AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dateCreated
Date
Readonly
|
Date created.
Format: URL Encoded ISO-8601
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dateModified
Date
Readonly
|
Date modified.
Format: URL Encoded ISO-8601
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hierarchyDisplay
ObjectN/A
Readonly
|
Display information for the company, group, or location. This is based on the hierarchyDisplaySetting.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
inheritedFromGroup
ListN/A
Readonly
|
List of Setting field names where the setting was inherited from its GroupSee the Effective Settings and Effective Settings Preview endpoint definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
inheritedFromCompany
ListN/A
Readonly
|
List of Setting field names where the setting was inherited from the CompanySee the Effective Settings and Effective Settings Preview endpoint definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceList
List
services for this Company. This will include the data for each service that has been
configured for this company. The settings for these services for this company can be edited with a PATCH.
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serviceAllowId
Numeric10
Required
|
The id for this service. This id is required to update this service.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serviceName
Alpha10
Readonly
|
The type of service. Potential values:
CASH, CHECK, CARD, IVR, RECURRING,
GENERAL,TOKENIZER,SIGNATURE. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
status
Boolean9
|
The status of the service. Valid Values: - ACTIVE: The service is ready and available for production use.- DEMO: The service is can be used, but transactions will be sent through a sandbox system and will not be billed.- INACTIVE: The service cannot be used.- CONFIGURE: The service must be configured before use. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendor
Alpha12
ReadOnly
|
The name of the vendor for the service. Valid Values: - PDC4U: For services TOKENIZER, SIGNATURE, GENERAL, CASH, RECURRING.- TSS: For service CHECK.- USAePay: For service CARD.- Clover: For service CARD.- Payrazr: For services CARD, CHECK.- Newtek: For service CARD.- PayNSeconds: For service CARD.- Voxeo: For service IVR.- Payliance: For service CHECK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
accountDirectiveList
List
ReadOnly
|
A list of account directives for the service. These can be edited individually on the Company Account Directive endpoint.
ONLY ON CARD, CHECK and CASH services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureCompanyLogo
AlphaNumeric
|
A Base64 representation of the company logo that is shown in the Signature service.ONLY on the SIGNATURE service.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureCompanyName
AlphaNumeric45
|
A custom name that is displayed on Flow requests. ONLY on SIGNATURE service.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureMiniMiranda
AlphaNumeric1024
|
A mini miranda to be displayed on Flow requests. ONLY on SIGNATURE service.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureFromEmailAddress
AlphaNumeric75
|
An email address that will be displayed as the From email address on Flow email requests. ONLY on SIGNATURE service.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
batchClosingHour
Numeric2
|
The closing hour for the ACH batch. Format: 24hr. ONLY on CHECK services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
allowCredit
Boolean5
|
Whether ACH credits are allowed with this service/vendor. ONLY on CHECK services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
exceptionReportIsEnabled
Boolean5
|
Whether ACH exception reports will be sent daily to the specified email. ONLY on CHECK services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
exceptionReportLink
Alpha8
|
If the exception report is enabled, which PDC4U system will the exception reports link to. ONLY on CHECK services.Valid values: FlowUI, NoLink.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendorSettings
Object
|
Settings that are specific to this vendor for this service. Currently, ONLY on CHECK services and only with Payliance and TSS vendors.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
accountDirectiveList
List
|
Account directives specifically for this service. ONLY on CASH, CHECK and CARD services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billingEmails
Object
billingEmails for this Company. These emails will receive an invoice each month and also notification when the payment on the invoice has failed or been completed successfully.
Click here to see the BillingEmails object
| Attribute | Description |
|
primaryList
List
|
A list of email addresses for which billing invoices and bill processing details will be posted.
These email addresses, comma separated, cannot exceed 100 characters.
The total email addresses in this BillingEmails object cannot exceed a count of 10.
|
|
secondaryList
List
|
A list of email addresses for which billing invoices and bill processing details will be posted.
These email addresses, comma separated, cannot exceed 100 characters.
The total email addresses in this BillingEmails object cannot exceed a count of 10.
|
Group Object
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
POST to create a new Group
PUT to update a Group overwriting all existing values
GET to get a Group or list of Groups
DELETE to delete a Group record. Any associated locations will still exist but will be unassigned from any group
Request Examples
Response Example
Click to view Full Group Object
Group Object:
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationCount": 1,
"locationIds": [
12
],
"locations": [
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
groupId
Numeric
|
The id of the Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customId
AlphaNumeric25
|
A custom, editable id for the group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locationIds
ListN/A
|
List of ids for associated Locations in the Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locationCount
Numeric
|
The number of associated Locations in the Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
settings
Object
|
The Settings for this Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locations
ListN/A
|
List of associated Locations
See the Location Object definition.
NOTE: This list is only returned when a single Group is requested.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Group Creation
POST :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Sample Response:
{
"customId": "NewGroupCustom12345",
"groupId": 1111,
"locationIds": [
15,
3
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"description": "Our company is great",
"hierarchyDisplaySetting": "LOCATION",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customId
AlphaNumeric25
|
A custom, editable id for the group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locationIds
ListN/A
|
List of ids for associated Locations in the Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
settings
Object
Required
|
The Settings for this Group.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locations
ListN/A
Readonly
|
List of associated Locations
NOTE: This is only returned when a single Group is requested.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Group Modification
PUT :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Sample Response:
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationIds": [
15,
3
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"description": "Our company is great",
"hierarchyDisplaySetting": "LOCATION",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
PUT requests will completely override the existing specified (by groupId in the URL) group. As such, the request object the same as the group creation.
Click to view the group object
Attribute
Description
customId
AlphaNumeric25
A custom, editable id for the group.
locationIds
ListN/A
List of
ids for associated Locations in the Group.
settings
Object
Required
The
Settings for this Group.
Attribute
Description
name
Alphanumeric100
Conditional
The name of the group or location for which these settings apply.
Required for Group and Location.
description
Alphanumeric150
A description of the company, group or location for which these settings apply.
address
Object
Address for this location/group/company
Attribute
Description
streetAddressOne
Alphanumeric60
Conditional
Street Address One.
Required for Company.
streetAddressTwo
Alphanumeric30
Street Address Two.
city
Alphanumeric45
Conditional
City.
Required for Company.
state
Alphanumeric2
Conditional
State.
Required for Company.
zip
NumericString5
Conditional
Zip Code.
Required for Company.
zipPlusFour
NumericString4
Four digit Zip Code extension.
country
Alphanumeric2
Conditional
Country.
Required for Company.
receiptText
Alphanumeric5000
Text that will show on a receipt for transactions processed by this location/group/company.
scheduleText
Alphanumeric5000
Text that will show on a schedule for this location/group/company.
cardFeeAmount
Numeric7
Fee for a card transaction processed by this location/group/company.
achFeeAmount
Numeric7
Fee for an ach transaction processed by this location/group/company.
hierarchyDisplaySetting
Enum
This defines whether the company, group or location name and address will display on schedules and transaction receipts.
Valid Values: COMPANY, GROUP, LOCATION.
There must be a group configured for the level to be GROUP.
There must be an active location configured for the level to be LOCATION.
cardAccountDirectiveList
ListN/A
List of Card
AccountDirective
Attribute
Description
accountDirective
Alphanumeric10
Readonly
The Account Directive.
name
Alphanumeric20
Readonly
The name of the Account Directive.
isActive
Boolean5
Only editable on company accountDirective endpoint
Whether the account directive is active. Only active account directives can be used for processing.
maximumAmountPerTransaction
Decimal11
The maximum amount allowed on transactions with this account directive.
vendor
Alpha20
The vendor for this account directive.
Valid Values:
- PDC4U: For service CASH.
- TSS: For service CHECK.
- USAePay: For service CARD.
- Clover: For service CARD.
- Payrazr: For services CARD, CHECK.
- Newtek: For service CARD.
- PayNSeconds: For service CARD.
- Payliance: For service CHECK.
entryCode
Alpha3
Conditional
ONLY ON Check Account Directives
Only editable on company accountDirective endpoint. Cannot be set to null or empty.
The entry code for the ach transaction to be processed with.
Valid Values: TEL, WEB, PPD, CCD, ARC, RCK.
merchantId
AlphaNumeric20
The merchant id for this account directive.
ONLY ON Card Account Directives.
merchantServiceProvider
AlphaNumeric10
The name of the merchant service provider that this account directive is tied to.
ONLY ON Card Account Directives.
vendorSettings
Object
Settings that are specific to this vendor for this account directive.
Attribute
Description
CARD: USAePay
sourceKey
Alphanumeric32
Required
The sourceKey for connecting with the processor.
pin
Numeric10
Required
The pin for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: Clover
apiKey
AlphaNumeric40
Required
The api key for connecting with the processor.
CARD: Newtek
affiliateId
AlphaNumeric50
Required
An id used for connecting with the processor.
cashierId
AlphaNumeric50
Required
An id used for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: PayNSeconds
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
isZipRequired
Boolean5
Required
Is the zip required for transactions.
isStateRequired
Boolean5
Required
Is the state required for transactions.
apiKey
AlphaNumeric50
Required
Key for connecting to the processor.
apiSecret
AlphaNumeric50
Required
Secret for connecting to the processor.
clientId
AlphaNumeric50
Required
The clientId with the processor.
locationId
AlphaNumeric50
Required
The locationId with the processor.
CARD: PayRazr
username
AlphaNumeric45
Required
The username for connecting to the processor.
password
AlphaNumeric45
Required
The password for connecting to the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
CHECK: Payliance
apiKey
AlphaNumeric512
Required
Key for connecting to the processor.
dateApiKeyExpiration
Date19
Required
The date the
apiKey expires. PDCflow will renew the key or regenerate a new one before this date.
CHECK: PayRazr
payrazrUsername
AlphaNumeric45
Required
The api username for connecting to the processor.
payrazrPassword
AlphaNumeric45
Required
The api password for connecting to the processor.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
achNowUsername
AlphaNumeric45
Required
The username for connecting to the processor.
achNowPassword
AlphaNumeric45
Required
The password for connecting to the processor.
CHECK: TSS
accountSet
AlphaNumeric2
Required
The account set for identifying the account with the processor.
allowedCardTypeList
List4
Conditional
ONLY ON Card Account Directives.
Cannot be set to an empty list.
A list of card types that are allowed to be processed with this account directive and its associated merchant account.
Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS.
zeroCostFeePercent
Numeric6
Only editable on company accountDirective endpoint
The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%).
Format: #.####
replacingAccountDirective
Alphanumeric10
An account directive to change pending payments to. When setting an
accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.
Not returned in response.
achAccountDirectiveList
ListN/A
List of ACH
AccountDirective
Attribute
Description
accountDirective
Alphanumeric10
Readonly
The Account Directive.
name
Alphanumeric20
Readonly
The name of the Account Directive.
isActive
Boolean5
Only editable on company accountDirective endpoint
Whether the account directive is active. Only active account directives can be used for processing.
maximumAmountPerTransaction
Decimal11
The maximum amount allowed on transactions with this account directive.
vendor
Alpha20
The vendor for this account directive.
Valid Values:
- PDC4U: For service CASH.
- TSS: For service CHECK.
- USAePay: For service CARD.
- Clover: For service CARD.
- Payrazr: For services CARD, CHECK.
- Newtek: For service CARD.
- PayNSeconds: For service CARD.
- Payliance: For service CHECK.
entryCode
Alpha3
Conditional
ONLY ON Check Account Directives
Only editable on company accountDirective endpoint. Cannot be set to null or empty.
The entry code for the ach transaction to be processed with.
Valid Values: TEL, WEB, PPD, CCD, ARC, RCK.
merchantId
AlphaNumeric20
The merchant id for this account directive.
ONLY ON Card Account Directives.
merchantServiceProvider
AlphaNumeric10
The name of the merchant service provider that this account directive is tied to.
ONLY ON Card Account Directives.
vendorSettings
Object
Settings that are specific to this vendor for this account directive.
Attribute
Description
CARD: USAePay
sourceKey
Alphanumeric32
Required
The sourceKey for connecting with the processor.
pin
Numeric10
Required
The pin for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: Clover
apiKey
AlphaNumeric40
Required
The api key for connecting with the processor.
CARD: Newtek
affiliateId
AlphaNumeric50
Required
An id used for connecting with the processor.
cashierId
AlphaNumeric50
Required
An id used for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: PayNSeconds
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
isZipRequired
Boolean5
Required
Is the zip required for transactions.
isStateRequired
Boolean5
Required
Is the state required for transactions.
apiKey
AlphaNumeric50
Required
Key for connecting to the processor.
apiSecret
AlphaNumeric50
Required
Secret for connecting to the processor.
clientId
AlphaNumeric50
Required
The clientId with the processor.
locationId
AlphaNumeric50
Required
The locationId with the processor.
CARD: PayRazr
username
AlphaNumeric45
Required
The username for connecting to the processor.
password
AlphaNumeric45
Required
The password for connecting to the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
CHECK: Payliance
apiKey
AlphaNumeric512
Required
Key for connecting to the processor.
dateApiKeyExpiration
Date19
Required
The date the
apiKey expires. PDCflow will renew the key or regenerate a new one before this date.
CHECK: PayRazr
payrazrUsername
AlphaNumeric45
Required
The api username for connecting to the processor.
payrazrPassword
AlphaNumeric45
Required
The api password for connecting to the processor.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
achNowUsername
AlphaNumeric45
Required
The username for connecting to the processor.
achNowPassword
AlphaNumeric45
Required
The password for connecting to the processor.
CHECK: TSS
accountSet
AlphaNumeric2
Required
The account set for identifying the account with the processor.
allowedCardTypeList
List4
Conditional
ONLY ON Card Account Directives.
Cannot be set to an empty list.
A list of card types that are allowed to be processed with this account directive and its associated merchant account.
Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS.
zeroCostFeePercent
Numeric6
Only editable on company accountDirective endpoint
The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%).
Format: #.####
replacingAccountDirective
Alphanumeric10
An account directive to change pending payments to. When setting an
accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.
Not returned in response.
locations
ListN/A
Readonly
List of associated
Locations
NOTE: This is only returned when a single Group is requested.
–Group Retrieval List
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Sample Response:
{
"groupList": [
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationCount": 1,
"locationIds": [
12
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"customId": "2233",
"groupId": 2323,
"locationCount": 1,
"locationIds": [
3333
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "1234-10",
"name": "PPD"
},
{
"accountDirective": "1234-11",
"name": "WEB"
},
{
"accountDirective": "1234-12",
"name": "TEL"
},
{
"accountDirective": "1234-5",
"name": "CCD"
}
],
"address": {
"city": "Here",
"country": "US",
"state": "UT",
"streetAddressOne": "1",
"zip": "88444"
},
"cardAccountDirectiveList": [
{
"accountDirective": "7777-3",
"allowedCardTypeList": [
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD",
"VISA"
],
"name": "Card present"
}
],
"dateCreated": "2020-10-15 19:53:11",
"dateModified": "2020-10-15 19:53:11",
"name": "Another Group Online"
}
}
]
}
Retrieve a list of all groups.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
–Group Retrieval Individual
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Sample Response:
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationCount": 1,
"locationIds": [
12
],
"locations": [
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
Retrieve an individual group by groupId.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/1111
–Group Retrieval Search
POST :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
Sample Response:
{
"groupList": [
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationCount": 1,
"locationIds": [
12
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"customId": "2233",
"groupId": 2323,
"locationCount": 1,
"locationIds": [
3333
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "1234-10",
"name": "PPD"
},
{
"accountDirective": "1234-11",
"name": "WEB"
},
{
"accountDirective": "1234-12",
"name": "TEL"
},
{
"accountDirective": "1234-5",
"name": "CCD"
}
],
"address": {
"city": "Here",
"country": "US",
"state": "UT",
"streetAddressOne": "1",
"zip": "88444"
},
"cardAccountDirectiveList": [
{
"accountDirective": "7777-3",
"allowedCardTypeList": [
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD",
"VISA"
],
"name": "Card present"
}
],
"dateCreated": "2020-10-15 19:53:11",
"dateModified": "2020-10-15 19:53:11",
"name": "Another Group Online"
}
}
]
}
| Attribute | Description |
|
groupName
Alphanumeric
|
Find Groups by their Name. This will search for any name that contains the search parameter.
|
|
groupNameOrCustomId
Alphanumeric
|
Find Groups by their Name or Custom ID (partial match). This will search for any name or customId that contains the search parameter.
|
|
groupIdList
NumericListN/A
|
Retrieve all Groups with a groupId in this list.
|
|
customIdList
AlphaNumericListN/A
|
Retrieve all Groups with a customId in this list.
|
Retrieve a list of all groups that match search parameters.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups
–Group Deletion
DELETE :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}
Delete an individual group by groupId.
Location
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
POST a new Location record
PUT an updated Location which will overwrite all existing values
GET a Location or list of Locations
PATCH an updated Location which will overwrite existing values if not null
A Location cannot be deleted. Rather, it can be inactivated such that it cannot be used, but will still be available for reporting.
Request Examples
Response Example
Click to view Full Location Object
Location Object:
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locationId
Numeric
|
The id of the Location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customId
Alphanumeric25
|
A custom unique identifier for referencing this location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
activation
Boolean5
|
Boolean stating if this Location is Active or Deactivated.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
groupData
Object
Readonly
|
Data pertaining to the Group this Location is a part of. If this location does not belong to a group, this field will not be present.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
settings
Object
|
The Settings for this Location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Location Creation
POST :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Sample Response:
{
"activation": true,
"customId": "123456",
"groupId": 1111,
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"description": "Our company is great",
"hierarchyDisplaySetting": "LOCATION",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customId
Alphanumeric25
|
A custom unique identifier for referencing this location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
activation
Boolean5
|
Boolean stating if this Location is Active or Deactivated.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
groupId
Numeric
|
The ID of the Group this location is a part of.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
settings
Object
|
The Settings for this Location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Location Modification
PUT :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}
Sample Response:
{
"activation": true,
"customId": "123456",
"groupId": 1111,
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"description": "Our company is great",
"hierarchyDisplaySetting": "LOCATION",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
PUT requests will completely override the existing specified (by locationId in the URL) location. As such, the request object the same as the location creation.
Click to view example
Attribute
Description
customId
Alphanumeric25
A custom unique identifier for referencing this
location.
activation
Boolean5
Boolean stating if this
Location is Active or Deactivated.
groupId
Numeric
The ID of the
Group this location is a part of.
settings
Object
The
Settings for this Location.
Attribute
Description
name
Alphanumeric100
Conditional
The name of the group or location for which these settings apply.
Required for Group and Location.
description
Alphanumeric150
A description of the company, group or location for which these settings apply.
address
Object
Address for this location/group/company
Attribute
Description
streetAddressOne
Alphanumeric60
Conditional
Street Address One.
Required for Company.
streetAddressTwo
Alphanumeric30
Street Address Two.
city
Alphanumeric45
Conditional
City.
Required for Company.
state
Alphanumeric2
Conditional
State.
Required for Company.
zip
NumericString5
Conditional
Zip Code.
Required for Company.
zipPlusFour
NumericString4
Four digit Zip Code extension.
country
Alphanumeric2
Conditional
Country.
Required for Company.
receiptText
Alphanumeric5000
Text that will show on a receipt for transactions processed by this location/group/company.
scheduleText
Alphanumeric5000
Text that will show on a schedule for this location/group/company.
cardFeeAmount
Numeric7
Fee for a card transaction processed by this location/group/company.
achFeeAmount
Numeric7
Fee for an ach transaction processed by this location/group/company.
hierarchyDisplaySetting
Enum
This defines whether the company, group or location name and address will display on schedules and transaction receipts.
Valid Values: COMPANY, GROUP, LOCATION.
There must be a group configured for the level to be GROUP.
There must be an active location configured for the level to be LOCATION.
cardAccountDirectiveList
ListN/A
List of Card
AccountDirective
Attribute
Description
accountDirective
Alphanumeric10
Readonly
The Account Directive.
name
Alphanumeric20
Readonly
The name of the Account Directive.
isActive
Boolean5
Only editable on company accountDirective endpoint
Whether the account directive is active. Only active account directives can be used for processing.
maximumAmountPerTransaction
Decimal11
The maximum amount allowed on transactions with this account directive.
vendor
Alpha20
The vendor for this account directive.
Valid Values:
- PDC4U: For service CASH.
- TSS: For service CHECK.
- USAePay: For service CARD.
- Clover: For service CARD.
- Payrazr: For services CARD, CHECK.
- Newtek: For service CARD.
- PayNSeconds: For service CARD.
- Payliance: For service CHECK.
entryCode
Alpha3
Conditional
ONLY ON Check Account Directives
Only editable on company accountDirective endpoint. Cannot be set to null or empty.
The entry code for the ach transaction to be processed with.
Valid Values: TEL, WEB, PPD, CCD, ARC, RCK.
merchantId
AlphaNumeric20
The merchant id for this account directive.
ONLY ON Card Account Directives.
merchantServiceProvider
AlphaNumeric10
The name of the merchant service provider that this account directive is tied to.
ONLY ON Card Account Directives.
vendorSettings
Object
Settings that are specific to this vendor for this account directive.
Attribute
Description
CARD: USAePay
sourceKey
Alphanumeric32
Required
The sourceKey for connecting with the processor.
pin
Numeric10
Required
The pin for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: Clover
apiKey
AlphaNumeric40
Required
The api key for connecting with the processor.
CARD: Newtek
affiliateId
AlphaNumeric50
Required
An id used for connecting with the processor.
cashierId
AlphaNumeric50
Required
An id used for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: PayNSeconds
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
isZipRequired
Boolean5
Required
Is the zip required for transactions.
isStateRequired
Boolean5
Required
Is the state required for transactions.
apiKey
AlphaNumeric50
Required
Key for connecting to the processor.
apiSecret
AlphaNumeric50
Required
Secret for connecting to the processor.
clientId
AlphaNumeric50
Required
The clientId with the processor.
locationId
AlphaNumeric50
Required
The locationId with the processor.
CARD: PayRazr
username
AlphaNumeric45
Required
The username for connecting to the processor.
password
AlphaNumeric45
Required
The password for connecting to the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
CHECK: Payliance
apiKey
AlphaNumeric512
Required
Key for connecting to the processor.
dateApiKeyExpiration
Date19
Required
The date the
apiKey expires. PDCflow will renew the key or regenerate a new one before this date.
CHECK: PayRazr
payrazrUsername
AlphaNumeric45
Required
The api username for connecting to the processor.
payrazrPassword
AlphaNumeric45
Required
The api password for connecting to the processor.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
achNowUsername
AlphaNumeric45
Required
The username for connecting to the processor.
achNowPassword
AlphaNumeric45
Required
The password for connecting to the processor.
CHECK: TSS
accountSet
AlphaNumeric2
Required
The account set for identifying the account with the processor.
allowedCardTypeList
List4
Conditional
ONLY ON Card Account Directives.
Cannot be set to an empty list.
A list of card types that are allowed to be processed with this account directive and its associated merchant account.
Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS.
zeroCostFeePercent
Numeric6
Only editable on company accountDirective endpoint
The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%).
Format: #.####
replacingAccountDirective
Alphanumeric10
An account directive to change pending payments to. When setting an
accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.
Not returned in response.
achAccountDirectiveList
ListN/A
List of ACH
AccountDirective
Attribute
Description
accountDirective
Alphanumeric10
Readonly
The Account Directive.
name
Alphanumeric20
Readonly
The name of the Account Directive.
isActive
Boolean5
Only editable on company accountDirective endpoint
Whether the account directive is active. Only active account directives can be used for processing.
maximumAmountPerTransaction
Decimal11
The maximum amount allowed on transactions with this account directive.
vendor
Alpha20
The vendor for this account directive.
Valid Values:
- PDC4U: For service CASH.
- TSS: For service CHECK.
- USAePay: For service CARD.
- Clover: For service CARD.
- Payrazr: For services CARD, CHECK.
- Newtek: For service CARD.
- PayNSeconds: For service CARD.
- Payliance: For service CHECK.
entryCode
Alpha3
Conditional
ONLY ON Check Account Directives
Only editable on company accountDirective endpoint. Cannot be set to null or empty.
The entry code for the ach transaction to be processed with.
Valid Values: TEL, WEB, PPD, CCD, ARC, RCK.
merchantId
AlphaNumeric20
The merchant id for this account directive.
ONLY ON Card Account Directives.
merchantServiceProvider
AlphaNumeric10
The name of the merchant service provider that this account directive is tied to.
ONLY ON Card Account Directives.
vendorSettings
Object
Settings that are specific to this vendor for this account directive.
Attribute
Description
CARD: USAePay
sourceKey
Alphanumeric32
Required
The sourceKey for connecting with the processor.
pin
Numeric10
Required
The pin for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: Clover
apiKey
AlphaNumeric40
Required
The api key for connecting with the processor.
CARD: Newtek
affiliateId
AlphaNumeric50
Required
An id used for connecting with the processor.
cashierId
AlphaNumeric50
Required
An id used for connecting with the processor.
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
CARD: PayNSeconds
zeroCostAllowBypass
Boolean5
Required
Whether the integration can allow a 0 fee for zero cost payments.
isZipRequired
Boolean5
Required
Is the zip required for transactions.
isStateRequired
Boolean5
Required
Is the state required for transactions.
apiKey
AlphaNumeric50
Required
Key for connecting to the processor.
apiSecret
AlphaNumeric50
Required
Secret for connecting to the processor.
clientId
AlphaNumeric50
Required
The clientId with the processor.
locationId
AlphaNumeric50
Required
The locationId with the processor.
CARD: PayRazr
username
AlphaNumeric45
Required
The username for connecting to the processor.
password
AlphaNumeric45
Required
The password for connecting to the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
CHECK: Payliance
apiKey
AlphaNumeric512
Required
Key for connecting to the processor.
dateApiKeyExpiration
Date19
Required
The date the
apiKey expires. PDCflow will renew the key or regenerate a new one before this date.
CHECK: PayRazr
payrazrUsername
AlphaNumeric45
Required
The api username for connecting to the processor.
payrazrPassword
AlphaNumeric45
Required
The api password for connecting to the processor.
zid
AlphaNumeric45
Required
An id used for identifying the account with the processor.
isStateRequired
Boolean5
Required
Is the state required for transactions.
achNowUsername
AlphaNumeric45
Required
The username for connecting to the processor.
achNowPassword
AlphaNumeric45
Required
The password for connecting to the processor.
CHECK: TSS
accountSet
AlphaNumeric2
Required
The account set for identifying the account with the processor.
allowedCardTypeList
List4
Conditional
ONLY ON Card Account Directives.
Cannot be set to an empty list.
A list of card types that are allowed to be processed with this account directive and its associated merchant account.
Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS.
zeroCostFeePercent
Numeric6
Only editable on company accountDirective endpoint
The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%).
Format: #.####
replacingAccountDirective
Alphanumeric10
An account directive to change pending payments to. When setting an
accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.
Not returned in response.
–Location Retrieval List
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Sample Response:
{
"locationList": [
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"activation": true,
"customId": "1568834598",
"locationId": 16,
"settings": {
"address": {
"city": "Sweet",
"country": "US",
"state": "IN",
"streetAddressOne": "1234 W 5678 S",
"streetAddressTwo": "1568834598",
"zip": "11225",
"zipPlusFour": "1234"
},
"dateCreated": "2019-08-29 07:19:10",
"dateModified": "2020-06-23 04:49:57",
"description": "the #1",
"name": "Second location",
"receiptText": "Receipt Text 1568834598",
"scheduleText": "Schedule Text 1568834598"
}
},
{
"activation": true,
"customId": "898465",
"locationId": 33,
"settings": {
"dateCreated": "2019-09-10 11:53:09",
"dateModified": "2020-04-15 09:29:32",
"name": "This location name"
}
}
]
}
Retrieve a list of all locations.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
–Location Retrieval Individual
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}
Sample Response:
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
}
Retrieve an individual location by locationId.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/12
–Location Retrieval Search
POST :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Sample Response:
{
"locationList": [
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"activation": true,
"customId": "1568834598",
"locationId": 16,
"settings": {
"address": {
"city": "Sweet",
"country": "US",
"state": "IN",
"streetAddressOne": "1234 W 5678 S",
"streetAddressTwo": "1568834598",
"zip": "11225",
"zipPlusFour": "1234"
},
"dateCreated": "2019-08-29 07:19:10",
"dateModified": "2020-06-23 04:49:57",
"description": "the #1",
"name": "Second location",
"receiptText": "Receipt Text 1568834598",
"scheduleText": "Schedule Text 1568834598"
}
},
{
"activation": true,
"customId": "898465",
"locationId": 33,
"settings": {
"dateCreated": "2019-09-10 11:53:09",
"dateModified": "2020-04-15 09:29:32",
"name": "This location name"
}
}
]
}
| Attribute | Description |
|
locationNameOrCustomId
Alphanumeric
|
Find Locations by their Name (partial match) or Custom ID (partial match). For example, if there is a Location named “My Cool Location”, this Location could be found by passing in locationNameOrCustomId=cool.
|
|
activation
Boolean
|
Find Locations by their Activation status. If parameter is not provided, Locations that are both Active or Inactive will return.
|
|
isAssignedToGroup
Boolean
|
Find Locations by their Group association status. If parameter is not provided, Locations with or without a Group will return.
|
|
locationIdList
NumericListN/A
|
Retrieve all Locations with a locationId in this list.
|
Retrieve a list of all locations that match search parameters.
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations
Effective Settings
These endpoints are to retrieve all the data to be used for request. This will combine all the data, inherited up to the COMPANY if it is empty or null in any of the children (Group or Location).
Objects retrieved from this endpoint will also include the inheritedFromGroup and/or the inheritedFromCompany variables that specify which values were inherited.
–Group Effective Settings List Search
Use this endpoint to retrieve a list of group objects, with their effective settings and an inheritedFromCompany field that defines which fields were inherited, filtered by GroupSearchParameters.
POST to retrieve a list of locations.
View GroupSearchParameters - Parameters to search groups by.
View Group object - A list of Group objects will be the response.
POST :
Test endpoint: https://scheduledemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/effectivesettings/search
Live endpoint: https://schedule.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/effectivesettings/search
Sample Response:
{
"groupList": [
{
"customId": "MyFacilityId4321",
"groupId": 1111,
"locationCount": 1,
"locationIds": [
12
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"customId": "2233",
"groupId": 2323,
"locationCount": 1,
"locationIds": [
3333
],
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "1234-10",
"name": "PPD"
},
{
"accountDirective": "1234-11",
"name": "WEB"
},
{
"accountDirective": "1234-12",
"name": "TEL"
},
{
"accountDirective": "1234-5",
"name": "CCD"
}
],
"address": {
"city": "Here",
"country": "US",
"state": "UT",
"streetAddressOne": "1",
"zip": "88444"
},
"cardAccountDirectiveList": [
{
"accountDirective": "7777-3",
"allowedCardTypeList": [
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD",
"VISA"
],
"name": "Card present"
}
],
"dateCreated": "2020-10-15 19:53:11",
"dateModified": "2020-10-15 19:53:11",
"name": "Another Group Online"
}
}
]
}
POST to retrieve a list of groups, with their effective settings, based on the parameters.
| Attribute | Description |
|
groupName
Alphanumeric
|
Find Groups by their Name. This will search for any name that contains the search parameter.
|
|
groupNameOrCustomId
Alphanumeric
|
Find Groups by their Name or Custom ID (partial match). This will search for any name or customId that contains the search parameter.
|
|
groupIdList
NumericListN/A
|
Retrieve all Groups with a groupId in this list.
|
|
customIdList
AlphaNumericListN/A
|
Retrieve all Groups with a customId in this list.
|
–Location Effective Settings List Search
Use this endpoint to retrieve a list of location objects, with their settings inherited from their group or company, filtered by LocationSearchParameters.
POST to retrieve a list of locations with their inherited settings.
View LocationSearchParameters - Parameters to search locations by.
View Location object - A list of Location objects, with their inherited settings, will be the response.
POST :
Test endpoint: https://scheduledemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/effectivesettings/search
Live endpoint: https://schedule.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/effectivesettings/search
Sample Response:
{
"locationList": [
{
"activation": true,
"customId": "123456",
"groupData": {
"customId": "Group123",
"id": 123,
"name": "Best Group"
},
"locationId": 12,
"settings": {
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"achFeeAmount": "2.50",
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cardFeeAmount": "1.25",
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"dateCreated": "2020-06-01 12:00:15",
"dateModified": "2020-12-16 05:13:22",
"description": "Our company is great",
"hierarchyDisplay": {
"address": {
"city": "New York",
"country": "US",
"state": "AK",
"streetAddressOne": "My street",
"streetAddressTwo": "address",
"zip": "12345",
"zipPlusFour": "1234"
},
"name": "Inherited Name",
"phoneNumber": "1231230987"
},
"hierarchyDisplaySetting": "COMPANY",
"name": "Best Name",
"receiptText": "Thank you for doing what you did.",
"scheduleText": "Thank you for setting up payments with us."
}
},
{
"activation": true,
"customId": "1568834598",
"locationId": 16,
"settings": {
"address": {
"city": "Sweet",
"country": "US",
"state": "IN",
"streetAddressOne": "1234 W 5678 S",
"streetAddressTwo": "1568834598",
"zip": "11225",
"zipPlusFour": "1234"
},
"dateCreated": "2019-08-29 07:19:10",
"dateModified": "2020-06-23 04:49:57",
"description": "the #1",
"name": "Second location",
"receiptText": "Receipt Text 1568834598",
"scheduleText": "Schedule Text 1568834598"
}
},
{
"activation": true,
"customId": "898465",
"locationId": 33,
"settings": {
"dateCreated": "2019-09-10 11:53:09",
"dateModified": "2020-04-15 09:29:32",
"name": "This location name"
}
}
]
}
POST to retrieve a list of locations, with their settings inherited from the group or company, based on the parameters.
| Attribute | Description |
|
locationNameOrCustomId
Alphanumeric
|
Find Locations by their Name (partial match) or Custom ID (partial match). For example, if there is a Location named “My Cool Location”, this Location could be found by passing in locationNameOrCustomId=cool.
|
|
activation
Boolean
|
Find Locations by their Activation status. If parameter is not provided, Locations that are both Active or Inactive will return.
|
|
isAssignedToGroup
Boolean
|
Find Locations by their Group association status. If parameter is not provided, Locations with or without a Group will return.
|
|
locationIdList
NumericListN/A
|
Retrieve all Locations with a locationId in this list.
|
–Location Effective Settings List Account Directives
Use this endpoint to retrieve a list of accountDirective objects for a list of locationIds. This will return all the distinct account directives for the locations. If multiple locations have access to the same account directive, that directive will only be represented once in the list.
POST to retrieve a list of inherited account directives for the list of locations.
View AccountDirectiveList object - A list of distinct accountDirective objects, will be the response.
POST :
Test endpoint: https://scheduledemo.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/locations/effectivesettings/accountdirectives
Live endpoint: https://schedule.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/locations/effectivesettings/accountdirectives
Sample Response:
{
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
],
"locationIdList": [
43,
45,
11297,
11298,
11299
]
}
POST to retrieve a list of locations, with their settings inherited from the group or company, based on the parameters.
| Attribute | Description |
|
locationNameOrCustomId
Alphanumeric
|
Find Locations by their Name (partial match) or Custom ID (partial match). For example, if there is a Location named “My Cool Location”, this Location could be found by passing in locationNameOrCustomId=cool.
|
|
activation
Boolean
|
Find Locations by their Activation status. If parameter is not provided, Locations that are both Active or Inactive will return.
|
|
isAssignedToGroup
Boolean
|
Find Locations by their Group association status. If parameter is not provided, Locations with or without a Group will return.
|
|
locationIdList
NumericListN/A
|
Retrieve all Locations with a locationId in this list.
|
Account Directives
–Search Account Directives
POST :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Sample Response:
{
"achAccountDirectiveList": [
{
"accountDirective": "2071-1217",
"entryCode": "WEB",
"isActive": true,
"name": "Test 1209",
"vendor": "PAYLIANCE",
"vendorSettings": {
"apiKey": "1231312",
"dateApiKeyExpiration": "2024-01-01"
}
},
{
"accountDirective": "2071-1",
"entryCode": "TEL",
"isActive": true,
"name": "TEL payments",
"vendor": "TSS",
"vendorSettings": {
"accountSet": "01"
}
}
],
"cardAccountDirectiveList": [
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
},
{
"accountDirective": "2019-2",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card not present",
"vendor": "PAYRAZR",
"vendorSettings": {
"password": "clever",
"username": "felix",
"zid": "13213123aaa"
},
"zeroCostFeePercent": "0.35"
}
],
"cashAccountDirectiveList": [
{
"accountDirective": "2109-1",
"isActive": true,
"name": "Flush with Cash",
"vendor": "PDC4U"
}
]
}
POST an AccountDirectiveSearchParameters object to retrieve a list of account directives that match the search parameters. Providing no search parameters will return a list of ALL accountDirectives for the company.
| Attribute | Description |
|
accountDirectiveList
ListN/A
|
Find all account directives with the account directive in the list. |
|
serviceNameList
ListN/A
|
Find account directives that belong to services in the list. Valid values: CARD, CHECK, CASH
|
|
nameList
ListN/A
|
Find account directives that have a name that matches a value in the list. |
|
nameWildcard
Alphanumeric20
|
Find all account directives with names that contain the nameWildcard.
|
|
activation
Boolean5
|
Only return ACTIVE or INACTIVE account directives. Leave null to return all account directives. |
|
vendorNameList
ListN/A
|
Find all account directives matching vendors with names in list. |
–Edit Account Directive
PATCH :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Sample Response:
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
PATCH an AccountDirective object to modify an existing account directive. The account directive being modified must be in the request body. With a PATCH request, only passed in fields will be updated. Fields set to empty strings
in the request will be set empty on the object.
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
accountDirective
Alphanumeric10
Readonly
|
The Account Directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name
Alphanumeric20
Readonly
|
The name of the Account Directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isActive
Boolean5
|
Only editable on company accountDirective endpoint Whether the account directive is active. Only active account directives can be used for processing. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
maximumAmountPerTransaction
Decimal11
|
The maximum amount allowed on transactions with this account directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendor
Alpha20
|
The vendor for this account directive. Valid Values: - PDC4U: For service CASH.- TSS: For service CHECK.- USAePay: For service CARD.- Clover: For service CARD.- Payrazr: For services CARD, CHECK.- Newtek: For service CARD.- PayNSeconds: For service CARD.- Payliance: For service CHECK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
entryCode
Alpha3
Conditional
|
ONLY ON Check Account Directives Only editable on company accountDirective endpoint. Cannot be set to null or empty. The entry code for the ach transaction to be processed with. Valid Values: TEL, WEB, PPD, CCD, ARC, RCK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantId
AlphaNumeric20
|
The merchant id for this account directive. ONLY ON Card Account Directives. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantServiceProvider
AlphaNumeric10
|
The name of the merchant service provider that this account directive is tied to. ONLY ON Card Account Directives. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendorSettings
Object
|
Settings that are specific to this vendor for this account directive.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
allowedCardTypeList
List4
Conditional
|
ONLY ON Card Account Directives. Cannot be set to an empty list. A list of card types that are allowed to be processed with this account directive and its associated merchant account. Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
zeroCostFeePercent
Numeric6
|
Only editable on company accountDirective endpoint The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%). Format: #.#### |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
replacingAccountDirective
Alphanumeric10
|
An account directive to change pending payments to. When setting an accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.Not returned in response. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/lists/companies/accountdirectives
Sample Response:
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
PUT an AccountDirective object to modify an existing account directive. The account directive being modified must be in the request body. With a PUT request, the entire object will be overridden.
As such, all required fields must be passed in the request.
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
accountDirective
Alphanumeric10
Readonly
|
The Account Directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name
Alphanumeric20
Readonly
|
The name of the Account Directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isActive
Boolean5
|
Only editable on company accountDirective endpoint Whether the account directive is active. Only active account directives can be used for processing. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
maximumAmountPerTransaction
Decimal11
|
The maximum amount allowed on transactions with this account directive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendor
Alpha20
|
The vendor for this account directive. Valid Values: - PDC4U: For service CASH.- TSS: For service CHECK.- USAePay: For service CARD.- Clover: For service CARD.- Payrazr: For services CARD, CHECK.- Newtek: For service CARD.- PayNSeconds: For service CARD.- Payliance: For service CHECK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
entryCode
Alpha3
Conditional
|
ONLY ON Check Account Directives Only editable on company accountDirective endpoint. Cannot be set to null or empty. The entry code for the ach transaction to be processed with. Valid Values: TEL, WEB, PPD, CCD, ARC, RCK. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantId
AlphaNumeric20
|
The merchant id for this account directive. ONLY ON Card Account Directives. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantServiceProvider
AlphaNumeric10
|
The name of the merchant service provider that this account directive is tied to. ONLY ON Card Account Directives. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vendorSettings
Object
|
Settings that are specific to this vendor for this account directive.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
allowedCardTypeList
List4
Conditional
|
ONLY ON Card Account Directives. Cannot be set to an empty list. A list of card types that are allowed to be processed with this account directive and its associated merchant account. Valid Values: MASTERCARD, VISA, DISCOVER, AMERICAN_EXPRESS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
zeroCostFeePercent
Numeric6
|
Only editable on company accountDirective endpoint The percent fee charged by the merchant on zero cost transactions. This is expected in decimal basis point format (ex. use 0.04 to represent 4%). Format: #.#### |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
replacingAccountDirective
Alphanumeric10
|
An account directive to change pending payments to. When setting an accountDirective to INACTIVE,
provide this parameter and all pending payments will be updated to this new account directive.Not returned in response. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–GET Company Account Directive
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/companies/effectivesettings/accountdirectives/{accountDirective}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/companies/effectivesettings/accountdirectives/{accountDirective}
Sample Response:
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
GET the details of an AccountDirective. The serviceName and vendorName parameters are both optional, but providing them in the URL will retrieve an account directive only if it exists for that service or vendor or both. This is useful for validating an account directive.
–GET Group Account Directive
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}/effectivesettings/accountdirectives/{accountDirective}?serviceName={serviceName}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/groups/{groupId}/effectivesettings/accountdirectives/{accountDirective}?serviceName={serviceName}
Sample Response:
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
GET the details of an AccountDirective. The serviceName parameter in the URL is required and will retrieve an account directive only if it exists for that service. Valid values are CARD, CHECK, or CASH.
This will get the account directive if it is explicitly set on the group, or if there are no directives set on the group and this account directive is inherited from the company.
–GET Location Account Directive
GET :
Test urls:
https://companyadministrationdemo.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}/effectivesettings/accountdirectives/{accountDirective}?serviceName={serviceName}
Live urls:
https://companyadministration.pdc4u.com/CompanyAdministrationService/api/v1_0/locations/{locationId}/effectivesettings/accountdirectives/{accountDirective}?serviceName={serviceName}
Sample Response:
{
"accountDirective": "2109-1",
"allowedCardTypeList": [
"VISA",
"AMERICAN_EXPRESS",
"DISCOVER",
"MASTERCARD"
],
"isActive": true,
"name": "Card present",
"vendor": "USAEPAY",
"vendorSettings": {
"pin": "1",
"sourceKey": "123123",
"zeroCostAllowBypass": false
},
"zeroCostFeePercent": "0.025"
}
GET the details of an AccountDirective. The serviceName parameter in the URL is required and will retrieve an account directive only if it exists for that service. Valid values are CARD, CHECK, or CASH.
This will get the account directive if it is explicitly set on the location, or if there are no directives set on the location and this account directive is inherited from the group or company.
Reference Objects
These objects are used as part of the objects defined above. These are included here for reference.
–Setting
Each Setting field applies to a Company or Location or Group.
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name
Alphanumeric100
Conditional
|
The name of the group or location for which these settings apply. Required for Group and Location.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
description
Alphanumeric150
|
A description of the company, group or location for which these settings apply. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
address
Object
|
Address for this location/group/company
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
receiptText
Alphanumeric5000
|
Text that will show on a receipt for transactions processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
scheduleText
Alphanumeric5000
|
Text that will show on a schedule for this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cardFeeAmount
Numeric7
|
Fee for a card transaction processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
achFeeAmount
Numeric7
|
Fee for an ach transaction processed by this location/group/company. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hierarchyDisplaySetting
Enum
|
This defines whether the company, group or location name and address will display on schedules and transaction receipts. Valid Values: COMPANY, GROUP, LOCATION.There must be a group configured for the level to be GROUP.
There must be an active location configured for the level to be LOCATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cardAccountDirectiveList
ListN/A
|
List of Card AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
achAccountDirectiveList
ListN/A
|
List of ACH AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cashAccountDirectiveList
ListN/A
|
List of Cash AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dateCreated
Date
Readonly
|
Date created.
Format: URL Encoded ISO-8601
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dateModified
Date
Readonly
|
Date modified.
Format: URL Encoded ISO-8601
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hierarchyDisplay
ObjectN/A
Readonly
|
Display information for the company, group, or location. This is based on the hierarchyDisplaySetting.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
inheritedFromGroup
ListN/A
Readonly
|
List of Setting field names where the setting was inherited from its GroupSee the Effective Settings and Effective Settings Preview endpoint definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
inheritedFromCompany
ListN/A
Readonly
|
List of Setting field names where the setting was inherited from the CompanySee the Effective Settings and Effective Settings Preview endpoint definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
–Hierarchy Display
| Attribute | Description | ||||||||||||||||
|
name
Alphanumeric100
|
The name of the location, group, or company. | ||||||||||||||||
|
address
Object
|
Address of the location/group/company. Depending on what hierarchy level this is from, parts of this object may be null. A Company will always have all parts (with the exception of streetAddressTwo). A Group or Location may have only individual parts.
|
–Address
| Attribute | Description |
|
streetAddressOne
Alphanumeric60
Conditional
|
Street Address One. Required for Company.
|
|
streetAddressTwo
Alphanumeric30
|
Street Address Two. |
|
city
Alphanumeric45
Conditional
|
City. Required for Company.
|
|
state
Alphanumeric2
Conditional
|
State. Required for Company.
|
|
zip
NumericString5
Conditional
|
Zip Code. Required for Company.
|
|
zipPlusFour
NumericString4
|
Four digit Zip Code extension. |
|
country
Alphanumeric2
Conditional
|
Country. Required for Company.
|
–Group Search Parameters
POST these parameters to the Group retrieval endpoint to filter the search.
| Attribute | Description |
|
groupName
Alphanumeric
|
Find Groups by their Name. This will search for any name that contains the search parameter.
|
|
groupNameOrCustomId
Alphanumeric
|
Find Groups by their Name or Custom ID (partial match). This will search for any name or customId that contains the search parameter.
|
|
groupIdList
NumericListN/A
|
Retrieve all Groups with a groupId in this list.
|
|
customIdList
AlphaNumericListN/A
|
Retrieve all Groups with a customId in this list.
|
–Location Search Parameters
POST these parameters to the Location retrieval endpoint to filter the search.
| Attribute | Description |
|
locationNameOrCustomId
Alphanumeric
|
Find Locations by their Name (partial match) or Custom ID (partial match). For example, if there is a Location named “My Cool Location”, this Location could be found by passing in locationNameOrCustomId=cool.
|
|
activation
Boolean
|
Find Locations by their Activation status. If parameter is not provided, Locations that are both Active or Inactive will return.
|
|
isAssignedToGroup
Boolean
|
Find Locations by their Group association status. If parameter is not provided, Locations with or without a Group will return.
|
|
locationIdList
NumericListN/A
|
Retrieve all Locations with a locationId in this list.
|
–Account Directive List
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
locationIdList
ListN/A
|
The list of location ids that were used to retrieve the account directives for. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cardAccountDirectiveList
ListN/A
|
List of Card AccountDirective
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
achAccountDirectiveList
ListN/A
|
List of ACH AccountDirective
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||