Required permission: | CreatePayments |
POST | /Finance/Payment/Log |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
process | body | string | No | |
action | body | string | No | |
note | body | string | No | |
message | body | string | No | |
order_id | body | string | No | |
external_payment_id | body | int | No | |
regent_id | body | int | No | |
amount | body | decimal | No | |
payment_type | body | string | No | |
customer_ip | body | string | No | |
name | body | string | No | |
body | string | No | ||
phone | body | string | No | |
addr1 | body | string | No | |
addr2 | body | string | No | |
city | body | string | No | |
state | body | string | No | |
country | body | string | No | |
code | body | string | No | |
current_status | body | string | No | |
current_status_date | body | DateTime? | No | |
pushed_to_gl | body | bool | No | |
pushed_to_gl_date | body | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
paymentUUID | form | string | No | |
order_id | form | string | No | |
external_payment_id | form | int | No | |
added_date | form | DateTime | No | |
regent_id | form | int | No | |
uuid | form | string | No | |
amount | form | decimal | No | |
payment_type | form | string | No | |
is_pushed_to_gl | form | bool | No | |
current_status | form | string | No | |
current_status_date | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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-01T00:00:00.0000000","pushed_to_gl":false,"pushed_to_gl_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"paymentUUID":"String","order_id":"String","external_payment_id":0,"added_date":"0001-01-01T00:00:00.0000000","regent_id":0,"uuid":"String","amount":0,"payment_type":"String","is_pushed_to_gl":false,"current_status":"String","current_status_date":"0001-01-01T00:00:00.0000000"}