Obtener un pago

Acción

GET https://api.paypertic.com/pagos/:id

Parámetros de la respuesta

Nombre	Tipo	Formato	Descripción
id	String		Identificador de la transacción.
external_transaction_id	String		Identificador unívoco de la transacción para la entidad
type	String		Tipo de pago. Valores: debit: Débito en cuenta o tarjeta. online: Transacción online con tarjeta. transfer: Transferencia en cuenta. debin: Transacción debin. coupon: Cupón de pago.
collector_id	String		Identificador del comercio.
return_url	String		URL a la cual redirige el formulario de ingreso de datos de métodos de pago una vez finalizado el pago.
back_url	String		URL a la cual redirige el formulario de pago al realizar clic en el botón regresar.
notification_url	String		URL a la cual se estarán enviado las notificaciones del pago.
form_url	String		URL del formulario de pago.
details	Array (Object)		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		Descripción 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	##.00	Tasa de interés anual a cobrar pasada la fecha de vencimiento.
charge_delay	Float	##.00	Monto fijo a cobrar pasada la fecha de vencimiento.
currency_id	String		Identificador de moneda. Valores disponibles.
payment_methods	Array (Object)
amount	Float		Monto a pagar con el medio de pago.
media_payment_id	Integer		Identificador del medio de pago.
first_six_digits	String		Primeros seis dígitos del medio de pago.
last_four_digits	String		Últimos cuatro dígitos 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	String		Código de autorización.
ticket_number	String		Numero de ticket generado por el medio de pago.
holder	Object		Titular del medio de pago.
name	String		Nombre.
identification	Object		Documento del titular.
type	String		Tipo de documento.
number	String		Número.
country	String	ISO 3166-1 alfa-3	País de expedición.
gateway	Object		Gateway del pago.
establishment_number	String		Número del establecimiento.
merchant_id	String		Identificador del usuario en el gateway.
transaction_id	String		Identificador de la transacción.
batch_number	String		Número de lote.
ticket_number	String		Número de ticket.
payer	Object
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 expedición.
phones	Array (Object)		Listado de números telefónicos.
description	String		Descripció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)		Detalle de las comisión. Están expresadas en la misma moneda que la transacción.
type	String		Tipo de cargo. 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. rebilling_cost: Costo de refacturación tariff : Arancel financial_cost: Costo de financiamiento overdue_payment: Costo de vencimiento others: Otros
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	##.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)		Listado de reembolsos. Están 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.
relateds	Array (Object)		Pagos relacionados.
type	String		Tipo de relación. Valores:
payment_id	String		Identificador del pago relacionado.
status	String		Estado de la transacción. Valores: pending: El usuario aún no completó el proceso de pago. issued: El pago esta listo para ser enviado a cobrar. approved: El pago fue aprobado y acreditado. 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. objected: El pago se encuentra objetado por el pagador. review: El pago esta pendiente de aprobación por parte de la entidad. validate: El pago esta pendiente de aprobación por parte del pagador.
status_detail	String		Detalle del estado (Ej: En un pago rechazado puede venir la leyenda del rechazo "Sin Fondo")
validation	Boolean		Si necesita validación por parte del pagador.
review	Boolean		Si requiere revisión por parte de la entidad.
upgradeable	Boolean		Si se puede actualizar el pago.
request_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de envío de la transacción.
due_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de vencimiento.
last_due_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de último vencimiento.
process_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha en la que se proceso el pago.
paid_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de pago.
rejected_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de rechazo.
cancel_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de cancelación.
accreditation_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de acreditación.
review_validation_date	Date	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	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	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Fecha de diferimiento del pago.
last_updated_date	Date	yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone	Última fecha de actualización.
metadata	Object		Objeto JSON para adjuntar datos al pago.
carrier	String		Carrier
source	String		Origen del ultimo cambio del pago.
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.

Errores posibles

4000 Invalid request.
4001 Invalid payment id.
4100 Access denied.
5001 Internal service error.

Page tree

Acción

Parámetros de la respuesta

Errores posibles

1 Comment

Anonymous