Add New Invoice Payment

Production

https://{{subdomain}}.daftara.com/api2

POST

/invoice_payments{format}

Record a payment against an invoice.

Send the payment under an InvoicePayment object. To create several payments in one call, send an array of payment objects under InvoicePayment instead.

Required: invoice_id, amount, and payment_method. payment_method must be one of the account's active configured payment methods (e.g. cash, bank, cheque, or an enabled online gateway key).

Several fields are set automatically and cannot be supplied by the caller: the payment status (new payments are marked Completed), the recording staff, the currency (taken from the invoice), and the payer contact details (name/address are copied from the invoice's client). Any such fields included in the request are ignored.

On success the endpoint responds with 202 Accepted and the new payment id.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

The payment was created.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftara.com/api2/invoice_payments.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"InvoicePayment":{"invoice_id":109,"amount":150.5,"payment_method":"cash","date":"2026-06-28","transaction_id":""}}'

Response Example

202 - Example 1

{
    "result": "successful",
    "code": 202,
    "id": 2415,
    "invoice_number": "INV-0001"
}

GET Single Invoice Payment

Edit Invoice Payments