POST
/
v1
/
invoices
/
{id}
/
cancel
cURL
curl --request POST \
  --url https://api.paycashless.com/v1/invoices/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>' \
  --data '{
  "cancellationReason": "<string>"
}'
{
  "id": "<string>",
  "status": "draft",
  "description": "<string>",
  "currency": "NGN",
  "maxInstallments": 123,
  "number": "<string>",
  "reference": "<string>",
  "acceptPartialPayments": true,
  "amountDue": 123,
  "amountPaid": 123,
  "amountOverpaid": 123,
  "amountRemaining": 123,
  "subTotal": 123,
  "customerId": "<string>",
  "sendEmail": true,
  "totalInclusiveTaxAmount": 123,
  "totalExclusiveTaxAmount": 123,
  "cancellationReason": "<string>",
  "taxRateIds": [
    "<string>"
  ],
  "logo": "<string>",
  "invoicePdf": "<string>",
  "receiptPdf": "<string>",
  "callbackUrl": "<string>",
  "returnUrl": "<string>",
  "metadata": {},
  "daysUntilDue": 123,
  "dueDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "liveMode": true
}

Headers

Request-Signature
string
required

SHA-512 HMAC signature of the request payload using the API secret

Minimum length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Path Parameters

id
string
required
Example:

"inv_ff0c3z37zi40pvc82g74bgsm4q7fubbw"

Body

application/json
cancellationReason
string
required

Response

200 - application/json

Invoice cancelled successfully

id
string
required
status
enum<string>
required
Available options:
draft,
open,
paid,
partially_paid,
cancelled
description
string
required
currency
enum<string>
required
Available options:
NGN,
USD
maxInstallments
number
required
number
string
required
reference
string
required
acceptPartialPayments
boolean
required
amountDue
number
required
amountPaid
number
required
amountOverpaid
number
required
amountRemaining
number
required
subTotal
number
required
customerId
string
required
sendEmail
boolean
required
totalInclusiveTaxAmount
number
required
totalExclusiveTaxAmount
number
required
cancellationReason
string | null
required
taxRateIds
string[]
required
invoicePdf
string | null
required
receiptPdf
string | null
required
callbackUrl
string | null
required
returnUrl
string | null
required
metadata
object | null
required
daysUntilDue
number
required
dueDate
string<date-time>
required
paidAt
string<date-time> | null
required
cancelledAt
string<date-time> | null
required
liveMode
boolean
required