Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Path Parameters

id
string
required

id identifier

Body

application/json
allocatedAmount
number
required

Allocated amount to this bill

Example:

12450

paymentSource
enum<string>
default:FLUIDEPAY

Payment source

Available options:
FLUIDEPAY,
MANUAL,
BANK_TRANSFER,
CASH,
CHEQUE
fluidePayTransactionId
string

FluidePay transaction id (required when paymentSource=FLUIDEPAY)

Maximum string length: 128
Example:

"TXN-98234-B"

externalReference
string

External reference (bank transfer reference, cash receipt #, cheque #, etc.)

Maximum string length: 128
currency
string

Currency code

Maximum string length: 3
Example:

"USD"

memo
string

Reference / memo

Maximum string length: 500
evidenceDocumentIds
string<uuid>[]

Evidence file upload ids (PDF receipts, bank slips, etc.)

cashAccountId
string<uuid>

Cash/bank GL account to credit for non-FluidePay payments (required when paymentSource != FLUIDEPAY). Must be a cash-like ASSET account.

Response

Record payment allocation against a bill — created

success
boolean
required

Whether the request succeeded

Example:

true

message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data
object

Endpoint-specific payload