Skip to main content
GET
/
invoices
/
{id}
Get invoice by id
curl --request GET \
  --url https://api.palomma.com/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "ready",
  "amount": 123,
  "description": "<string>",
  "contract": "<string>",
  "customerDocumentNumber": "<string>",
  "createdAt": "<string>",
  "paymentUrl": "<string>",
  "reference": "<string>",
  "expirationDate": "<string>",
  "customerName": "<string>",
  "paymentDate": "2023-11-07T05:31:56Z",
  "paymentMethod": "pse",
  "paymentSource": "whatsapp",
  "paymentAmount": 123,
  "settlementDate": "<string>",
  "settlementTime": "<string>",
  "paymentId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Send header: Authorization: Bearer <apiKey>.

Path Parameters

​
id
string
required

Invoice id.

Response

Invoice found

​
id
string
required

Unique invoice identifier.

​
status
enum<string>
required

Invoice status: ready (payment link active), paid, cancelled, or chargeback.

Available options:
ready,
paid,
cancelled,
chargeback
​
amount
number
required

Invoice amount in COP.

​
description
string
required

Invoice description.

​
contract
string
required

Contract identifier.

​
customerDocumentNumber
string
required

Customer's document number.

​
createdAt
string
required

Invoice creation datetime (ISO 8601).

​
paymentUrl
string<uri>
required

Palomma hosted payment page URL for this invoice.

​
reference
string

Merchant-provided invoice reference.

​
expirationDate
string

Payment link expiration datetime (ISO 8601). Invoices expire 5 minutes after creation, so redirect the customer immediately. Once a transaction is in progress, it no longer expires until the transaction completes.

​
customerName
string

Customer's display name.

​
paymentDate
string<date-time>

When the invoice was paid. Present on paid and chargeback invoices.

​
paymentMethod
enum<string>

Payment method used. Present on paid and chargeback invoices.

Available options:
pse,
nequiButton,
bancolombiaButton,
breb,
card
​
paymentSource
enum<string>

Channel through which payment was made. Present on paid and chargeback invoices.

Available options:
whatsapp,
portal,
link
​
paymentAmount
number

Amount actually paid in COP. Present on paid and chargeback invoices.

​
settlementDate
string

Expected settlement date (YYYY-MM-DD). Present on paid and chargeback invoices.

​
settlementTime
string

Expected settlement cycle. Present on paid and chargeback invoices.

​
paymentId
string

Payment identifier. Present on paid and chargeback invoices.