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.

Query Parameters

organizationId
string
required
force
boolean

Body

application/json
correlationId
string<uuid>
required

Allocation id (idempotency key)

receiptNumber
string
required
Maximum string length: 64
invoiceNumber
string
required
Maximum string length: 64
companyName
string
required
Maximum string length: 255
customerName
string
required
Maximum string length: 255
amountPaid
number
required
totalPaid
number
required
balanceDue
number
required
currency
string
required
Maximum string length: 3
paymentDate
string
required
Maximum string length: 32
paymentMethod
string
required
Maximum string length: 64
transactionReference
string
required
Maximum string length: 128

Response

Created successfully

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