Skip to main content
POST
Record a manual payment against an invoice

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id
string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Path Parameters

id
string<uuid>
required

Body

application/json
amount
paidAt
null | string<date-time>
notes
null | string

Response

Created

currency
string
required
status
string
required
providerReference
string
required
id
string<uuid>
invoiceId
string<uuid>
organisationId
string<uuid>
amount
provider
any
Available options:
Stripe,
Manual,
Yapily,
null
chargeReference
null | string
applicationFeeAmount
notes
null | string
receiptUrl
null | string
receiptEmail
null | string
paymentMethod
null | object
billing
null | object
risk
null | object
succeededAt
null | string<date-time>
createdAt
string<date-time>