Add a payment to an invoice
POST
https://api.zenoti.com/v1/invoices/{invoice_id}/payments
Records a payment against an open invoice. Supports cash, card, gift card, loyalty points, and custom payment methods.
Before you begin
Permission: Manage API Keys (under Administrator ) — Required to access Zenoti APIs.
Endpoint
POST /v1/invoices/{invoice_id}/payments
Base URL: https://api.zenoti.com
Request
Path parameters
Request body
Response
Success (200 OK)
{
"transaction_id": "00000000-0000-0000-0000-2e6c5e7c7449",
"remaining_balance": 0.00,
"error": null
}
Response fields
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/invoices/a2b3c4d5-e6f7-8901-bcde-f23456789012/payments' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{ "payment_mode": 0, "amount": 130.80 }'
const response = await fetch('https://api.zenoti.com/v1/invoices/{invoice_id}/payments', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({ payment_mode: 0, amount: 130.8 })
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/invoices/{invoice_id}/payments',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'payment_mode': 0, 'amount': 130.8}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new { paymentMode = 0, amount = 130.8 }),
Encoding.UTF8, "application/json");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/invoices/{invoice_id}/payments", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/invoices/{invoice_id}/payments')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { payment_mode: 0, amount: 130.8 }.to_json
response = http.request(request)
data = JSON.parse(response.body)
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.zenoti.com/v1/invoices/{invoice_id}/payments');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: bearer {{access_token}}',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['payment_mode' => 0, 'amount' => 130.8]));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
Error codes