Obtener un pago

Acción

GET /api/v2/pagos/:id

Nombre	Tipo	Acceso	Formato	Descripción
id	String	readable		Identificador del pago.
type	String	writable		Tipo de pago. Valores: debit: Debito en cuenta o tarjeta. online: Transacción online con tarjeta. transfer: Transferencia en cuenta. debin: Transacción debin coupon: Cupon de pago.
collector_id	String	writable		Identificador del comercio.
return_url	String	writable		URL a la cual redirige el formulario de ingreso de datos de metodos de pago una vez finalizado el pago.
back_url	String	writable		URL a la cual redirige el formulario de pago al realizar clic en el boton regresar.
notification_url	String	writable		URL a la cual se estaran enviado las notificaciones del pago.
form_url	String	readable		URL
details	Array (Object)	readable \| writable		Listado de pagos que conforman la transacción. Puede tener mas de un pago dentro de una transacción o referenciar a pagos pendientes ya registrados realizados. También se puede enviar pagos a diferentes comercios los cuales deben declarar y registrar la relación de los mismos.
payment_id	String			Identificador del pago. Se puede enviar el identificador para obtener los datos de un pago pendiente ya registrado en la plataforma, de esta forma la transacción actual realizara el pago del mismo.
external_reference	String			Referencia o id externo a la plataforma para uso del comercio.
concept_id	String			Identificador del concepto del pago definido por el comercio.
concept_description	String			Descripcion del concepto del pago definido por el comercio.
amount	Float		##.00	Monto del pago.
collector_id	String			Identificador del comercio. Se puede enviar un identificador distinto al del comercio que esta realizando la transacción, los cuales deben declarar y registrar la relación de los mismos.
rate	Float	writable	##.00	Tasa de interes anual a cobrar pasada la fecha de vencimiento.
charge_delay	Float	writable	##.00	Monto fijo a cobrar pasada la fecha de vencimiento.
currency_id	String	readable \| writable		Identificador de moneda. Valores: USD: Dolar estadounidense EUR: Euro ARS: Pesos Argentinos BRL: Reales Brazileros COP: Pesos Colombianos
payment_methods	Array (Object)	readable \| writable
authorization_transactionId	String			ID de transacción de autorización.
amount	Float			Monto a pagar con el medio de pago.
media_payment_id	Integer			Identificador del medio de pago.
number	String			Número del medio de pago.
installments	Integer			Cuotas.
promotion_id	String			Identificador de la promoción.
expiration_year	Integer			Año de expiración de la tarjeta
expiration_month	Integer			Mes de expiración de la tarjeta
authorization_code	Integer			Código de autorización
token	String			Token de ingreso de datos de tarjeta.
cardholder	Object			Titular de la tarjeta.
name	String			Nombre.
identification	Object			Documento del titular de la tarjeta.
type	String			Tipo de documento.
number	String			Número.
country	String		ISO 3166-1 alfa-3	País de expedicion.
payer	Object	readable \| writable		Datos del pagador.
id	String			Identificador del pagador. Se obtiene del servicio de CUSTOMERS
name	String			Nombre.
email	String			Email.
identification	Object			Documento del pagador.
type	String			Tipo de documento.
number	String			Número.
country	String		ISO 3166-1 alfa-3	País de expedicion.
phones	Array (Object)			Lisado de números telefónicos.
description	String			Descipción del número.
country_code	Integer			Código de país.
area_code	Integer			Código de área.
number	Integer			Números telefónico.
extension	Integer			Extensión.
fee_details	Array (Object)	readable		Detalle de las comisión. Estan expresadas en la misma moneda que la transacción.
type	String			Tipo de cardo. Valores: fee: Comisión por transacción. carrier_fee: Arancel del carrier. media_payment_cost: Costo del medio de pago. carrier_cost: Costo del carrier. refund_cost: Costo por reembolso. deferred_cost: Costo por diferir el pago. discount: Descuentos.
fee_payer	String			Quien paga. Valores: collector: El comercio absorbe. payer: El pagador lo absorbe.
description	String			Razón de la comisión.
amount	Float		##.00	Monto de la comisión.
final_amount	Float	readable	##.00	Monto final de la transacción. Es la suma de los montos de los detalles mas las comisión aplicadas al pagador.
refunds	Array (Object)	readable		Listado de reembolsos. Estan expresadas en la misma moneda que la transacción.
id	String			Identificador del reembolso.
amount	Float		##.00	Monto de reembolso.
source	Object			Origen del reembolso.
id	String			Identificador del origen.
name	String			Nombre.
type	String			Origen de la transacción. Valores: collector: Comercio. system: Sistema interno. backoffice: Operador de backoffice. customer: Pagador. carrier: Carrier.
metadata	Object			Objeto JSON para adjuntar datos al reembolso.
retries	Array (Object)	readable		Reintentos de pagos.
payment_id	String			Identificador del pago de reintento.
status	String	readable		Estado de la transacción. Valores: pending: El usuario aún no completó el proceso de pago. approved: El pago fue aprobado y acreditado. authorized: El pago ha sido autorizado pero aún no fue capturado. in_process: El pago fue enviado al medio de pago para el proceso. rejected: El pago fue rechazado. El usuario puede intentar pagar nuevamente. cancelled: El pago fue cancelado por una de las partes, o porque el tiempo expiró. refunded: El pago fue devuelto al usuario. deferred: El pago se encuentra diferido por el pagador. dismissed: El pago se encuentra objetado por el pagador. review: El pago esta pendiente de aprovacion por parte de la entidad. validate: El pago esta pendiente de aprocacion por parte del pagador.
status_detail	String	readable		Detalle del estado (Ej: En un pago rechazado puede venir la leyenda del rechazo "Sin Fondo")
validation	Boolean	readable		Si necesita validación por parte del pagador.
review	Boolean	readable		Si requiere revisión por parte de la entidad.
upgradeable	Boolean	readable		Si se puede actualiar el pago.
request_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de envio de la transacción.
due_date	Date	readable \| writable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de vencimiento.
last_due_date	Date	readable \| writable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de último vencieminto.
process_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha en la que se proceso el pago.
paid_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de pago.
rejected_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de rechazo.
cancel_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de cancelación.
accreditation_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de acreditación.
review_validation_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de validación del pago por parte de la entidad.
payer_validation_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de validación del pago por parte del pagador.
payer_deferred_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de diferimiento del pago.
last_updated_date	Date	readable	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Última fecha de actualización.
metadata	Object	writable		Objeto JSON para adjuntar datos al pago.
carrier	String	writable		Carrier
source	String	readable
id	String			Identificador del origen.
name	String			Nombre.
type	String			Origen de la transacción. Valores: collector: Comercio. system: Sistema interno. backoffice: Operador de backoffice. customer: Pagador. carrier: Carrier.

Page tree

Obtener un pago

Acción