GET
/
v1
/
invoices
/
{id}
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/invoices/{id} \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "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>",
  "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,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "quantity": 123,
      "price": 1000,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "taxRates": [
    {
      "id": "<string>",
      "name": "<string>",
      "percentage": 123
    }
  ]
}

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"

Response

200 - application/json

Invoice retrieved

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
integer
required
amountPaid
integer
required
amountOverpaid
integer
required
amountRemaining
integer
required
subTotal
integer
required
customerId
string
required
sendEmail
boolean
required
totalInclusiveTaxAmount
integer
required
totalExclusiveTaxAmount
integer
required
cancellationReason
string | null
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
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
items
object[]
required
taxRates
object[]
required