Skip to content
ZUTAX ZUTAX Documentation

Record invoice payment

POST
/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/invoices/{invoice_id}/payments

Record immutable payment ledger entry and reconcile invoice balances.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
invoice_id
required
Invoice Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Workspace-ID
Any of:
string
X-API-Key
Any of:
string
X-Tenant-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
InvoicePaymentCreate

Create payment ledger entry for invoice.

object
amount
required
Any of:
number
> 0
currency
Currency
string
default: NGN <= 3 characters
payment_channel
InvoicePaymentChannel

How invoice payment was collected.

string
default: manual
Allowed values: flutterwave bank_transfer cash manual
external_reference
Any of:
string
<= 255 characters
provider_tx_id
Any of:
string
<= 255 characters
paid_at
Any of:
string format: date-time
note
Any of:
string
metadata
Any of:
object
key
additional properties
any
Examples

Request payload example

{
  "amount": 1,
  "currency": "NGN",
  "payment_channel": "flutterwave",
  "external_reference": "string",
  "provider_tx_id": "string"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Examples

201 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}