Add New Client Payment

Production

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

POST

/client_payments{format}

Record a payment for a client (an on-account / client payment).

Send the payment under a ClientPayment object. Required: client_id, amount, and payment_method. payment_method should be one of the account's 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 recording staff, the payer contact details (name/address are copied from the client record), the payment reference code, and the deposit treasury (chosen from the method or your default). Any such fields included in the request are ignored. If the amount matches an outstanding invoice for the client, the payment may be applied to that invoice automatically.

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

Access: requires the Add Payments to All permission.

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 client payment was created.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

202 - Example 1

{
    "result": "successful",
    "code": 202,
    "id": 2415
}

GET Single Client Payment

Edit Client Payments