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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePaymentLogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <action>String</action>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <amount>0</amount>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <customer_ip>String</customer_ip>
  <email>String</email>
  <external_payment_id>0</external_payment_id>
  <message>String</message>
  <name>String</name>
  <note>String</note>
  <order_id>String</order_id>
  <payment_type>String</payment_type>
  <phone>String</phone>
  <process>String</process>
  <pushed_to_gl>false</pushed_to_gl>
  <pushed_to_gl_date>0001-01-01T00:00:00</pushed_to_gl_date>
  <regent_id>0</regent_id>
  <state>String</state>
</FinancePaymentLogRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <added_date>0001-01-01T00:00:00</added_date>
  <amount>0</amount>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <external_payment_id>0</external_payment_id>
  <is_pushed_to_gl>false</is_pushed_to_gl>
  <order_id>String</order_id>
  <paymentUUID>String</paymentUUID>
  <payment_type>String</payment_type>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</FinancePaymentResponse>