Cancel an invoice payment

post/invoice-payment-cancel
SecuritybearerAuth
Request
Request Body schema: application/json

Cancel a pending invoice payment

invoiceId
required
integer <int64>

Invoice identifier

billRunType
required
string (BillRunType)

Bill run type

Enum: "NORMAL" "ADHOC"
notes
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+...

Reason for payment cancellation request

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "invoiceId": 0,
  • "billRunType": "NORMAL",
  • "notes": "string"
}