Skip to main content
POST
Cancel an invoice

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Body

application/json
reason
string
required
Required string length: 1 - 500

Response

200 - application/json

Invoice cancelled

id
string
required
publicId
string
required
orgId
string
required
buyerId
string
required
sellerConnectedAccountId
string
required
sellerExternalId
string | null
required
sellerName
string | null
required
status
enum<string>
required
Available options:
draft,
awaiting_approval,
approved,
awaiting_buyer,
buyer_kyc_pending,
buyer_kyc_approved,
buyer_kyc_rejected,
fx_quoted,
fx_expired,
on_ramp_pending,
on_ramp_failed,
fiat_received,
on_chain_confirmed,
offramp_pending,
offramp_failed,
settled,
partial_payment,
expired,
cancelled,
restored,
manual_review
currency
string
required
amount
string
required
requestNetworkId
string | null
required
paymentChain
string | null
required
paymentAddress
string | null
required
dueDate
string | null
required
expiresAt
string | null
required
cancelReason
string | null
required
pendingApproval
boolean
required
buyerRef
string | null
required
dueNumber
string | null
required
exportContractRef
string | null
required
incoterm
string | null
required
portOfLoading
string | null
required
feeBps
integer | null
required
feeAmount
string | null
required
brlSettledAmount
string | null
required
fxRateAtSettlement
string | null
required
createdAt
string
required
updatedAt
string
required
timeline
object[]
required
buyerEmail
string<email>
buyerName
string | null
lineItems
object[]