regis

<back to all web services

FinancePaymentLogRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/Payment/Log
FinancePaymentLogRequest Parameters:
NameParameterData TypeRequiredDescription
processbodystringNo
actionbodystringNo
notebodystringNo
messagebodystringNo
order_idbodystringNo
external_payment_idbodyintNo
regent_idbodyintNo
amountbodydecimalNo
payment_typebodystringNo
customer_ipbodystringNo
namebodystringNo
emailbodystringNo
phonebodystringNo
addr1bodystringNo
addr2bodystringNo
citybodystringNo
statebodystringNo
countrybodystringNo
codebodystringNo
current_statusbodystringNo
current_status_datebodyDateTime?No
pushed_to_glbodyboolNo
pushed_to_gl_datebodyDateTime?No
FinancePaymentResponse Parameters:
NameParameterData TypeRequiredDescription
paymentUUIDformstringNo
order_idformstringNo
external_payment_idformintNo
added_dateformDateTimeNo
regent_idformintNo
uuidformstringNo
amountformdecimalNo
payment_typeformstringNo
is_pushed_to_glformboolNo
current_statusformstringNo
current_status_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/Payment/Log HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	process: String,
	action: String,
	note: String,
	message: String,
	order_id: String,
	external_payment_id: 0,
	regent_id: 0,
	amount: 0,
	payment_type: String,
	customer_ip: String,
	name: String,
	email: String,
	phone: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	current_status: String,
	current_status_date: 0001-01-01,
	pushed_to_gl: False,
	pushed_to_gl_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	paymentUUID: String,
	order_id: String,
	external_payment_id: 0,
	added_date: 0001-01-01,
	regent_id: 0,
	uuid: String,
	amount: 0,
	payment_type: String,
	is_pushed_to_gl: False,
	current_status: String,
	current_status_date: 0001-01-01
}