Skip to main content
GET
/
lps
/
invoices
/
{id}
Get invoice
curl --request GET \
  --url https://api.cheqpay.dev/lps/invoices/{id} \
  --header 'x-api-key: <api-key>'
{
  "_id": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "paymentOrderId": "<string>",
  "paymentLinkId": "<string>",
  "reference": "<string>",
  "orderNumber": "<string>",
  "products": [
    {
      "_id": "<string>",
      "merchantId": "<string>",
      "name": "<string>",
      "price": 1,
      "id": "<string>",
      "description": "<string>",
      "status": "active",
      "imageUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totals": {
    "total": 123,
    "taxes": 123,
    "shipping": 123,
    "fees": 123,
    "discounts": 123
  },
  "billingAddress": {
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "email": "[email protected]",
    "phone": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "isSameAsShipping": true
  },
  "shippingAddress": {
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "email": "[email protected]",
    "phone": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "paymentMethod": {
    "type": "card",
    "card": {
      "bin": "<string>",
      "brand": "<string>",
      "country": "<string>",
      "expiryMonth": "<string>",
      "expiryYear": "<string>",
      "issuerBank": "<string>",
      "last4": "<string>",
      "type": "<string>"
    }
  },
  "status": "pending",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for merchant authentication

Path Parameters

id
string
required

Invoice ID

Response

Invoice retrieved successfully

Invoice details

_id
string

Invoice ID

customerId
string

Customer ID

merchantId
string

Merchant ID

paymentOrderId
string

Payment order ID

Payment link ID

reference
string

Merchant reference

orderNumber
string

Order number

products
object[]

Products in the invoice

totals
object
billingAddress
object

Address information

shippingAddress
object

Address information

paymentMethod
object

Payment method details

status
enum<string>

Invoice status

Available options:
pending,
paid,
cancelled,
refunded,
failed,
abandoned
metadata
object

Additional metadata

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp