Payment POST question

[beacondental]

Does the API allow payment post via the local program link bridge? For example, if a practice uses Global Payments (Xcharge), then can the API user run a Payment POST using xcharge as the payment tool? Or does the payment POST will allow us to post if we have a third party connection for merchant processing.

https://opendental.com/site/apipayments.html

[DerekR]

Good Afternoon beacondental,

Payments POST, as well as every API method, does not support interaction with any third party integrations that exist in Open Dental.

[beacondental]

Does the API allow Payment PUT to edit an existing payment that has been posted by the dental team. Is there a way to add this to the development list?
https://opendental.com/site/apipayments.html

[SLeon]

Good morning,

The API does not currently have a Payments PUT method. Which fields would you want to update for a payment?

[beacondental]

Payment PUT would be for these fields.
"PayType": 69,
"payType": "Check",
"CheckNum": "12798",
"BankBranch": "20-6",
"PayNote": "",
"DateEntry": "2022-06-24",
"Receipt": "",
"PaymentSource": "None",
"ProcessStatus": "OfficeProcessed",
"IsCcCompleted": "false",

[DerekR]

Good Morning beacondental,

We will look into the possibility of adding Payments PUT. The fields "Receipt", "PaymentSource", "ProcessStatus", and "IsCcComplete" are all complex and never set by the user. We will discuss these fields as a Team and update this thread once we have reached a decision.

To assist us in our discussion, could you please describe the workflow you are trying to achieve, and the situations that require you to change these four fields?

Thanks!

[beacondental]

Its really automate ProcessStatus as accepted online pending payment to processed payment. Right now, it says as pending and it can only be done manually.

[DerekR]

Good Morning,

We have discussed this thoroughly and have decided that we will Add Payments PUT to our development list. This method will allow you to update the PayType, CheckNum, BankBranch, and PayNote fields.

To assist with your workflow, we recommend creating Payment Type Definitions such as "Accepted Online", "Pending Payment", and "Processed Payment". This method would allow you to keep track of payments using your external system. Please see https://www.opendental.com/manual/defin ... types.html , https://opendental.com/site/apipayments.html , and https://opendental.com/site/apidefinitions.html for more information on creating and using Payment Types.

We will also enhance our Payments GET method to allow PayType as a Parameter to assist with this workflow.

[DerekR]

This feature request is complete.

Payments PUT is available starting in version 23.3.11.
Payments GET has been enhanced to now allow PayType as a search parameter starting in version 23.3.11.

See https://www.opendental.com/site/apipayments.html for more information.

Thanks!

[beacondental]

Would the payment PUT be for Putting ProcessStatus as accepted online pending payment to processed payment. Right now, it says as pending and it can only be done manually.

[DerekR]

Good Morning,

We have discussed this thoroughly and have decided that we will Add Payments PUT to our development list. This method will allow you to update the PayType, CheckNum, BankBranch, and PayNote fields.

To assist with your workflow, we recommend creating Payment Type Definitions such as "Accepted Online", "Pending Payment", and "Processed Payment". This method would allow you to keep track of payments using your external system. Please see https://www.opendental.com/manual/defin ... types.html , https://opendental.com/site/apipayments.html , and https://opendental.com/site/apidefinitions.html for more information on creating and using Payment Types.