Record invoice payment

POST

https://api.jokoor.com/v1/pay/invoices/{id}/payments

Last modified:2025-11-15 15:49:01

Maintainer:Not configured

OperationId:recordInvoicePayment

Record a payment against an invoice. Supports both full and partial payments.

Payment Recording:

Payments are tracked in the invoice's paid_amount field

remaining_amount is calculated as total_amount - paid_amount

Invoice status automatically updates to partially_paid or paid

Multiple partial payments can be recorded until fully paid

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Payment recorded successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

Full paymentPartial payment

curl --location --request POST 'https://api.jokoor.com/v1/pay/invoices//payments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "1150.00",
    "payment_method": "bank_transfer",
    "transaction_id": "TXN123456",
    "notes": "Payment received via bank transfer"
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "invoice_number": "string",
        "customer_id": "string",
        "customer_email": "user@example.com",
        "customer_name": "string",
        "customer_address": "string",
        "customer_phone": "string",
        "amount": "1000.00",
        "tax_rate": 15,
        "tax_amount": "150.00",
        "total_amount": "1150.00",
        "paid_amount": "500.00",
        "remaining_amount": "650.00",
        "currency": "GMD",
        "status": "draft",
        "payment_status": "unpaid",
        "due_date": "2019-08-24T14:15:22Z",
        "issued_date": "2019-08-24T14:15:22Z",
        "paid_date": "2019-08-24T14:15:22Z",
        "sent_at": "2019-08-24T14:15:22Z",
        "sent_count": 0,
        "notes": "string",
        "items": [
            {
                "product_id": "string",
                "description": "string",
                "quantity": 0,
                "unit_price": "string",
                "total": "string"
            }
        ],
        "payment_url": "string",
        "pdf_url": "string",
        "receipts": [
            {
                "id": "string",
                "receipt_number": "string",
                "receipt_url": "string",
                "amount": "string",
                "payment_date": "2019-08-24T14:15:22Z",
                "status": "string"
            }
        ],
        "metadata": {},
        "subscription_id": "string",
        "mode": "test",
        "livemode": true,
        "version": 0,
        "organization": {
            "id": "string",
            "name": "string",
            "logo_url": "string"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
    }
}

Modified at 2025-11-15 15:49:01

Download invoice PDF

List invoice payments