Saltar al contenido principal
GET
/
invoices
/
{id}
Obtener factura por 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>"
}

Autorizaciones

​
Authorization
string
header
requerido

Enviar header: Authorization: Bearer <apiKey>.

Parámetros de ruta

​
id
string
requerido

Id de la factura.

Respuesta

Factura encontrada

​
id
string
requerido

Identificador unico de la factura.

​
status
enum<string>
requerido

Estado de la factura: ready (link de pago activo), paid (pagada), cancelled (cancelada) o chargeback (contracargo).

Opciones disponibles:
ready,
paid,
cancelled,
chargeback
​
amount
number
requerido

Monto de la factura en COP.

​
description
string
requerido

Descripcion de la factura.

​
contract
string
requerido

Identificador del contrato.

​
customerDocumentNumber
string
requerido

Numero de documento del cliente.

​
createdAt
string
requerido

Fecha y hora de creacion de la factura (ISO 8601).

​
paymentUrl
string<uri>
requerido

URL de la pagina de pago de Palomma para esta factura.

​
reference
string

Referencia de factura proporcionada por el comercio.

​
expirationDate
string

Fecha y hora de expiracion del link de pago (ISO 8601). Las facturas expiran 5 minutos despues de la creacion, por lo que se debe redirigir al cliente de inmediato. Una vez que la transaccion esta en progreso, no expira hasta que se complete.

​
customerName
string

Nombre del cliente.

​
paymentDate
string<date-time>

Fecha y hora en que se pago la factura. Presente en facturas pagadas y con contracargo.

​
paymentMethod
enum<string>

Metodo de pago utilizado. Presente en facturas pagadas y con contracargo.

Opciones disponibles:
pse,
nequiButton,
bancolombiaButton,
breb,
card
​
paymentSource
enum<string>

Canal a traves del cual se realizo el pago. Presente en facturas pagadas y con contracargo.

Opciones disponibles:
whatsapp,
portal,
link
​
paymentAmount
number

Monto efectivamente pagado en COP. Presente en facturas pagadas y con contracargo.

​
settlementDate
string

Fecha esperada de liquidacion (YYYY-MM-DD). Presente en facturas pagadas y con contracargo.

​
settlementTime
string

Ciclo esperado de liquidacion. Presente en facturas pagadas y con contracargo.

​
paymentId
string

Identificador del pago. Presente en facturas pagadas y con contracargo.