GET Single Client Payment

Production

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

GET

/client_payments/{id}{format}

Retrieve a single client payment by its reference id.

Returns the payment record under data.ClientPayment. The id must be a numeric payment reference; only payments linked to a client are returned by this endpoint.

Access: available to the account owner, or to staff holding any of the View Invoice Details, View All Invoices, Add Invoice Payments, or Add Payments to All permissions.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Responses

🟢200OK

application/json

The client payment was found and returned.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/client_payments/113.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "code": 200,
    "result": "successful",
    "data": {
        "ClientPayment": {
            "id": 113,
            "invoice_id": 109,
            "client_id": 28,
            "payment_method": "cash",
            "amount": 10000,
            "transaction_id": "",
            "date": "2026-06-09 00:00:00",
            "email": "string",
            "status": 0,
            "notes": "string",
            "response_code": "string",
            "response_message": "string",
            "created": "2019-08-24T14:15:22.123Z",
            "modified": "2019-08-24T14:15:22.123Z",
            "added_by": 1,
            "currency_code": "EGP",
            "first_name": "string",
            "last_name": "string",
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country_code": "str",
            "phone1": "string",
            "phone2": "string",
            "ip": "104.28.162.140",
            "transaction_type": "string",
            "processed": true,
            "attachment": "string",
            "staff_id": 1,
            "payment_work_order_id": 0,
            "receipt_notes": "string",
            "treasury_id": 1,
            "pos_shift_id": 0,
            "branch_id": 1,
            "extra_details": "string",
            "source": "string",
            "code": "000051"
        }
    }
}

GET All Client Payments

Add New Client Payment