Consulta por párametros
Esta consulta permite filtrar transacciones del comercio de acuerdo a los diferentes parámetros definidos en cada solicitud. Es factible combinar más de dos parámetros en una única consulta.
Ruta
GET /v1/merchant/transaction/
Encabezado
Content-Type
application/json
x-auth-token*
{token}
Párametros
description
Proporciona detalles clave sobre la transacción y es lo que se refleja en los comprobantes de pago.
Ejemplo: Servicio de entrega
currency
Código que identifica la divisa del pago en formato ISO 4217.
COP | USD | MXN
amount
Es el código generado a partir del proceso de autenticación.
Ejemplo: 54000
amount_<gt>
gt: Significa "mayor que" (greater than).
lt: Significa "menor que" (less than).
ge: Significa "mayor o igual que" (greater than or equal to).
le: Significa "menor o igual que" (less than or equal to).
Ejemplo: 50000
status
Es el estado de la transacción al momento de creación.
pending | unlimit | scheduled | review | created | success
reference_one
reference_two
reference_three
reference_four
reference_five
reference_six
Información adicional de la transacción (número de factura, ordenes de compra, categoría), visible para los usuarios.
Ejemplo: FAC123
fee
Es el valor que se refiere al costo asociado a la transacción.
fee_<lt>
gt: Significa "mayor que" (greater than).
lt: Significa "menor que" (less than).
ge: Significa "mayor o igual que" (greater than or equal to).
le: Significa "menor o igual que" (less than or equal to).
Ejemplo: 1000
iva
Impuesto que se aplica al fee
payment_method
Método utilizado para realizar el pago de la transacción.
cash-hand | card | wallet | bank
source
Hace referencia a la fuente o origen de la transacción, indicando cómo se inició o generó dicha operación.
chat | api
channel
Es la forma como se realiza el cobro.
whatsapp | link | email
process_id
Es el identificador utilizado para hacer referencia a la transacción en el proceso de conciliación.
Ejemplo: a1a2a-a3a4a
payment_provider_source
Se refiere a la fuente proveedora de servicios de pago utilizada para realizar la transacción.
Ejemplo: Nequi
merchant_phone
Número de celular del usuario que genera el cobro (incluir el código de área del país).
Ejemplo: 573112229999
merchant_email
Correo del cliente al que se enviarán las notificaciones.
Ejemplo: [email protected]
merchant_doc
Número del documento de identificación del usuario asignado al cobro.
Ejemplo: 10000000
payer_phone
Número de celular del cliente (incluir el código de área del país)
Ejemplo: 573112223333
payer_email
Correo del cliente al que se enviarán las notificaciones.
Ejemplo: [email protected]
payer_doc
Número del documento de identificación del cliente.
Ejemplo: 10000000
affiliate_doc
Tipo de documento de identificación del afiliado.
CC | CE | NIT | PASAPORTE | DNI | EIN
affiliate_type_doc
Número del documento de identificación del afiliado.
Ejemplo: 11119999
invoice_type
Elige el tipo de vinculación que quieres realizar para esta transacción con tu software contable.
Obligatorio para el objeto invoice.
link | balance | create
invoice_id
Corresponde al identificador de la factura o el cliente según el tipo de vinculación definido.
Ejemplo: FV-2-1234 | GR1234 | 41515fb0-d815-40ac-86c0-4081eb642fa2
invoice_retentions
Solo si la vinculación es create, agregar las retenciones aplicables para la creación de la factura. Tener en cuenta que el valor de la factura será el valor de la transacción mas las retenciones definidas.
Formato: enviar las retenciones separadas por comas
Ejemplo: [1,2,3]
invoice_url
Enlace para descargar la factura del invoice.
invoice_voucher_id
Identificador del recibo de caja.
created_at_start_date
Es la fecha de creación desde la cual se quiere realizar la consulta.
Formato: AAAA/MM/DD
Ejemplo: 2025/01/30
created_at_end_date
Es la fecha de creación hasta la cual se quiere realizar la consulta.
Formato: AAAA/MM/DD
Ejemplo: 2025/01/30
updated_at_start_date
Es la fecha de la última actualización desde la cual se quiere realizar la consulta.
Formato: AAAA/MM/DD
Ejemplo: 2025/01/30
updated_at_end_date
Es la fecha de la última actualización hasta la cual se quiere realizar la consulta.
Formato: AAAA/MM/DD
Ejemplo: 2025/01/30
Respuesta
{
"transactions": [
{
"external_reference": "51j54e",
"process_id": "ecad3a2b-6ef6-4a75-a651-8445c8022b7e",
"description": "Transacción de ejemplo",
"status": "SUCCESS",
"amount": 1000,
"expected_amount": 1000,
"channel": "LINK",
"currency": "COP",
"reference_one": "BACKEND",
"reference_two": "UPTIME",
"reference_three": null,
"reference_four": null,
"reference_five": null,
"reference_six": null,
"reference_seven": null,
"reference_eight": null,
"merchant": {
"name": "ALEJANDRO PEREZ",
"phone": "573111112222",
"email": "[email protected]",
"id_number": "1000011111",
"id_type": "CC"
},
"payer": {
"name": "DIEGO PEREZ",
"phone": "573110011111",
"email": "[email protected]",
"id_number": "34000100",
"id_type": "CC"
},
"affiliate": {
"name": "CAMILO",
"id_number": "1000011111",
"id_type": "CC"
},
"limit_date": null,
"reminder_date": null,
"expected_date": null,
"created_at": "2024-08-01T09:34:28.054Z",
"updated_at": "2024-08-02T10:29:00.470Z"
}
]
}
{
"transactions": [
{
"external_reference": "61BUD1R4A",
"process_id": "62d61cb6-acec-4ee6-96ba-d3d278b56846",
"description": "Descripción Transacción (con recargo)",
"status": "CREATED",
"amount": 1000,
"expected_amount": 100000,
"channel": "WHATSAPP",
"currency": "COP",
"reference_one": "Referencia 1",
"reference_two": "Referencia 2",
"reference_three": "Referencia 3",
"reference_four": "Referencia 4",
"reference_five": "Referencia 5",
"reference_six": "Referencia 6",
"reference_seven": "Referencia 7",
"reference_eight": "Referencia 8",
"expiration": false,
"attachment": null,
"comments": null,
"payment_method": null,
"payment_provider_source": null,
"receipt_image": null,
"type": "inmediato",
"source": "api",
"merchant": {
"name": "ALEJANDRO PEREZ",
"phone": "573111112222",
"email": "[email protected]",
"id_number": "1000011111",
"id_type": "CC"
},
"payer": {
"name": "DIEGO PEREZ",
"phone": "573110011111",
"email": "[email protected]",
"id_number": "34000100",
"id_type": "CC"
},
"affiliate": {
"name": "CAMILO",
"id_number": "1000011111",
"id_type": "CC"
},
"invoice": {
"provider": null,
"type": null,
"id": null,
"retentions": null,
"url": null,
"voucher": null
},
"fees": {
"service_fee": null,
"service_variable": null,
"service_iva": null,
"service_saas": null,
"fee_settled": null,
"saas_settled": null
},
"payout_process_status": false,
"payout_process_id": null,
"return_review_reason": null,
"return_success_reason": null,
"cash_manual_process_status": false,
"cash_manual_reason": null,
"limit_date": "2025-05-22",
"expected_date": null,
"created_at": "2025-05-07T21:31:56.503Z",
"updated_at": "2025-06-17T20:47:45.983Z"
}
]
}Ejemplo
curl --location '{{base_url}}/v1/merchant/transaction/?amount_ge=10000' \
--header 'x-auth-token: {{token}}'El request solo ejemplifica a partir de cuatro párametros: [description, created_start_date, channel, amount_ge]. No obstante, es posible realizar el mismo con todos los filtros necesarios.
Casos de uso
Última actualización