PApalomma
Invoices

Get invoice by id

Retrieves a single invoice by its id.

get/invoices/{id}

Request

  • Base URL
    https://api.palomma.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

Invoice id.

Response

Invoice found

idstring required

Unique invoice identifier.

referencestring

Merchant-provided invoice reference.

status'ready' | 'paid' | 'cancelled' | 'chargeback' required

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

amountnumber required

Invoice amount in COP.

descriptionstring required

Invoice description.

contractstring required

Contract identifier.

expirationDatestring

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.

customerDocumentNumberstring required

Customer's document number.

customerNamestring

Customer's display name.

createdAtstring required

Invoice creation datetime (ISO 8601).

paymentDatestring date-time

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

paymentMethod'pse' | 'nequiButton' | 'bancolombiaButton' | 'breb' | 'card'

Payment method used. Present on paid and chargeback invoices.

paymentSource'whatsapp' | 'portal' | 'link'

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

paymentAmountnumber

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

settlementDatestring

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

settlementTimestring

Expected settlement cycle. Present on paid and chargeback invoices.

paymentIdstring

Payment identifier. Present on paid and chargeback invoices.

paymentUrlstring uri required

Palomma hosted payment page URL for this invoice.

Changes

No recorded changes to this operation across all 1 revision of this API.