Skip to main content
POST
/
api
/
v1
/
payments
/
invoices
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/payments/invoices" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "X-Workspace-Id: $FLUIDE_WORKSPACE_ID" \
  -H "X-Acting-Company-Id: $FLUIDE_COMPANY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

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.

Body

application/json
invoiceNumber
string
required
Maximum string length: 64
customerName
string
required
Maximum string length: 200
amountMinor
number
required
Required range: x >= 1
currency
string
required
Maximum string length: 3
Example:

"USD"

dueDate
string
required

ISO date (YYYY-MM-DD)

customerEmail
string<email>
description
string
Maximum string length: 2000
sendImmediately
boolean
default:false
allowedMethods
string[]

Checkout payment methods (e.g. FLUTTERWAVE_CARD, STRIPE_CARD)

Response

Invoice 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