post https://api.zenoti.com/v1/invoices//online_payments#
This API enables you to collect payment for an invoice by using a guest's previously-unsaved credit or debit card.
You must specify appropriate details for the invoice_id parameter in the request body, and this API will collect online payment for the invoice.
To collect invoice payment from a new payment account, follow these steps:
- Specify appropriate details for the
invoice_idparameter in the API request body. In the API response, a URI will be generated from the payment processor ashosted_payment_uri - Go to the provided
hosted_payment_uri. You are then redirected to a Web page from the payment processor. - Provide the required account details, and then click Pay Now.
You have successfully collected online payment for the specified invoice.
Note: Remove the hash (#) at the end, when using this API.
Response Details
| Name | Type | Description |
|---|---|---|
| token_id | string | Token or Reference number for processing the online payment transaction. |
| hosted_payment_uri | string | Represents the URI that redirects the cardholder to the 3D S screen. |
| error | Object | Object that contains error message and error code details. For more information, refer to the error Object table. |
error Object
| Name | Message |
|---|---|
| 418 | Invoice with id: not found. |
| 460 | Payment is already made in full. |
| 4023 | Something Went Wrong. |