Cash Payments

Making a Cash Payment

POST /api/pp/payments/authorize

Request Parameters

Field	Description	Required	Format	Max Len
method	Payment method	Yes	"CASH"	10
amount	US Dollar amount of payment	Yes	9999.99	12
tracking_id	Customer provided value for tracking payment	No		50
memo	Short memo or transaction descriptor	No		100

Patient Request Parameters

Field	Description	Required	Format	Max Len
patient_id	Unique ID for the patient	No	UUID	36
patient_external_id	Unique value for identifying the patient in your system	No		50
patient_prefix	Prefix	No		50
patient_first_name	First Name	No	[A-z]	50
patient_last_name	Last Name	No	[A-z]	50
patient_suffix	Suffix	No		50
patient_gender	Gender	No	M|F	1
patient_birth_date	Date of Birth	No	mm/dd/yyyy	10
patient_address_line1	Address Line 1	No		50
patient_address_line2	Address Line 2	No		50
patient_city	City	No		50
patient_state	State	No	[A-Z]	2
patient_zip_code	ZIP Code	No	999999999	9
patient_primary_phone	Primary Phone Number	No	9999999999	10
patient_mobile_phone	Mobile Phone Number	No	9999999999	10
patient_email_address	Email Address	No		128

Payment Plan Request Parameters

Field	Description	Required	Format	Max Len
payment_plan_id	Unique ID for the payment plan	No	UUID	36

Response Parameters

Field	Description	Format	Max Len
id	Unique ID for this payment	UUID	36
method	Payment method	"CASH"	10
action	Payment action	See below	10
results	Result of transaction	See below	10
code	Approval or error code	NULL	6
message	Approval or error message		32
cvv_indicator	CVV Indicator	NULL	1
avs_indicator	AVS Indicator	NULL	1
risk_indicator	Risk Indicator	NULL	1
timestamp	Date and time the transaction was made	YYYY-MM-DDThh:mm:ssZ	25
tracking_id	Customer provided value for tracking payment		50
memo	Short memo or transaction descriptor		100

Payment Action Values

Value	Description
AUTHORIZE	A payment authorization
VOID	A void of a previous PAYMENT
CREDIT	A credit (refund) of a previous PAYMENT

Example

POST /api/pp/payments
Content-Type: application/json
Content-Type: application/x-www-form-urlencoded

Parameters

Field	Value
method	card
amount	1000.00
tracking_id	PM1234-009
memo	Monthly Payment

Response

{
	"id" : "aa5122c7-f0fb-489b-ac68-aa0e21068cbb",
	"method" : "CASH",
	"action" : "AUTHORIZE",
	"results" : "APPROVED",
	"code" : null,
	"message" : "APPROVED",
	"cvv_indicator" : null,
	"avs_indicator" : null,
	"risk_indicator" : null,
	"timestamp" : "2013-01-31T16:00:00Z",
	"tracking_id" : "PM1234-009",
	"memo" : "Monthly Payment"
}

Getting a Payment

GET /api/pp/payments/{id}

Example

GET /api/pp/payments/aa5122c7-f0fb-489b-ac68-aa0e21068cbb

Response

{
	"id" : "aa5122c7-f0fb-489b-ac68-aa0e21068cbb",
	"method" : "CASH",
	"action" : "AUTHORIZE",
	"results" : "APPROVED",
	"code" : null,
	"message" : "APPROVED",
	"cvv_indicator" : null,
	"avs_indicator" : null,
	"risk_indicator" : null,
	"timestamp" : "2013-01-31T16:00:00Z",
	"tracking_id" : "PM1234-009",
	"memo" : "Monthly Payment"
}

Getting a list of Payments

GET /api/pp/payments?start_time={start_time}&end_time={end_time}

Request Parameters

Field	Description	Format	Max Len
start_time	Beginning date / time	YYYY-MM-DDThh:mm:ssZ	20
end_time	Ending date / time	YYYY-MM-DDThh:mm:ssZ	20

Example

GET /api/pp/payments?start_time=2013-01-31T16:00:00Z&end_time=2013-01-31T16:15:00Z

Response

[
{
	"id" : "aa5122c7-f0fb-489b-ac68-aa0e21068cbb",
	"method" : "CASH",
	"action" : "AUTHORIZE",
	"results" : "APPROVED",
	"code" : null,
	"message" : "APPROVED",
	"cvv_indicator" : null,
	"avs_indicator" : null,
	"risk_indicator" : null,
	"timestamp" : "2013-01-31T16:00:00Z",
	"tracking_id" : "PM1234-009",
	"memo" : "Monthly Payment"
}
,


{
	"id" : "e3835b53-509d-42f9-8e26-3405fd200917",
	"method" : "ACH",
	"action" : "AUTHORIZE",
	"results" : "APPROVED",
	"code" : null,
	"message" : "ACCEPTED",
	"risk_indicator" : "00",
	"timestamp" : "2013-01-31T16:10:00Z",
	"tracking_id" : "PM1234-010",
	"settlement_date" : "2013-02-01",
	"repaid_date" : "2013-02-02",
	"gateway" : "VANTIV",
	"client_id" : "T5QRP4B8",
	"memo" : "Monthly Payment"
}
]

Voiding a Payment

POST /api/pp/payments/{id}/void

Response Parameters

Field	Description	Format	Max Len
id	Unique ID for this void	UUID	36
method	Payment method	"CASH"	10
action	Payment action	"VOID"	10
results	Result of transaction	See below	10
code	Approval or error code		6
message	Approval or error message		32
timestamp	Date and time the transaction was made	YYYY-MM-DDThh:mm:ssZ	25

Example

POST /api/pp/payments/aa5122c7-f0fb-489b-ac68-aa0e21068cbb/void

Response

{
	"id" : "71a0e499-5a63-4e7f-8656-fb7b7eecd9c2",
	"method" : "CASH",
	"action" : "VOID",
	"results" : "APPROVED",
	"code" : null,
	"message" : "APPROVED",
	"timestamp" : "2013-01-31T16:20:00Z"
}