Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Acción

GET /api/v2/pagos/:id


Parámetros del mensaje


NombreTipoFormatoDescripción
idString
Identificador del pago.
typeString

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_idString
Identificador del comercio.
return_urlString
URL a la cual redirige el formulario de ingreso de datos de metodos de pago una vez finalizado el pago.
back_urlString
URL a la cual redirige el formulario de pago al realizar clic en el boton regresar.
notification_urlString
URL a la cual se estaran enviado las notificaciones del pago.
form_urlString
URL
detailsArray (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_idString
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_referenceString
Referencia o id externo a la plataforma para uso del comercio.
    concept_idString
Identificador del concepto del pago definido por el comercio.
    concept_descriptionString
Descripcion del concepto del pago definido por el comercio.
    amountFloat##.00Monto del pago.
    collector_idString
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.
rateFloat##.00Tasa de interes anual a cobrar pasada la fecha de vencimiento.
charge_delayFloat##.00Monto fijo a cobrar pasada la fecha de vencimiento.
currency_idString

Identificador de moneda. Valores:

  • USD: Dolar estadounidense

  • EUR: Euro
  • ARS: Pesos Argentinos
  • BRL: Reales Brazileros
  • COP: Pesos Colombianos
payment_methodsArray (Object)

    amountFloat
Monto a pagar con el medio de pago.
    media_payment_idInteger
Identificador del medio de pago.
    first_six_digitsString
Primeros seis digitos del medio de pago.
    last_four_digitsString
Ultimos cuatro digitos del medio de pago.
    installmentsInteger
Cuotas.
    promotion_idString
Identificador de la promoción.
    expiration_yearInteger
Año de expiración de la tarjeta.
    expiration_monthInteger
Mes de expiración de la tarjeta.
    authorization_codeInteger
Código de autorización.
    ticket_numberString
Numero de ticket generado por el medio de pago.
    holderObject
Titular del medio de pago.
        nameString
Nombre.
        identificationObject
Documento del titular.
            typeString
Tipo de documento.
            numberString
Número.
            countryStringISO 3166-1 alfa-3País de expedicion.
payerObject
Datos del pagador.
    idString
Identificador del pagador. Se obtiene del servicio de CUSTOMERS
    nameString
Nombre.
    emailString
Email.
    identificationObject
Documento del pagador.
        typeString
Tipo de documento.
        numberString
Número.
        countryStringISO 3166-1 alfa-3País de expedicion.
    phonesArray (Object)
Lisado de números telefónicos.
        descriptionString
Descipción del número.
        country_codeInteger
Código de país.
        area_codeInteger
Código de área.
        numberInteger
Números telefónico.
        extensionInteger
Extensión.
fee_detailsArray (Object)
Detalle de las comisión. Estan expresadas en la misma moneda que la transacción.
    typeString

Tipo de cardo. Valores:

  • feeComisió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_payerString

Quien paga. Valores:

  • collector: El comercio absorbe.
  • payer: El pagador lo absorbe.
    descriptionString
Razón de la comisión.
    amountFloat##.00Monto de la comisión.
final_amountFloat##.00Monto final de la transacción. Es la suma de los montos de los detalles mas las comisión aplicadas al pagador.
refundsArray (Object)
Listado de reembolsos. Estan expresadas en la misma moneda que la transacción.
    idString
Identificador del reembolso.
    amountFloat##.00Monto de reembolso.
    sourceObject
Origen del reembolso.
        idString
Identificador del origen.
        nameString
Nombre.
        typeString

Origen de la transacción. Valores:

  • collector: Comercio.
  • system: Sistema interno.
  • backoffice: Operador de backoffice.
  • customer: Pagador.
  • carrier: Carrier.
    metadataObject
Objeto JSON para adjuntar datos al reembolso.
relatedsArray (Object)
Pagos relacionados.
    typeString

Tipo de relación. Valores:


    payment_idString
Identificador del pago relacionado.
statusString

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_detailString
Detalle del estado (Ej: En un pago rechazado puede venir la leyenda del rechazo "Sin Fondo")
validationBoolean
Si necesita validación por parte del pagador.
reviewBoolean
Si requiere revisión por parte de la entidad.
upgradeableBoolean
Si se puede actualiar el pago.
request_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone
Fecha de envio de la transacción.
due_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone
Fecha de vencimiento.
last_due_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone
Fecha de último vencieminto.
process_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha en la que se proceso el pago.
paid_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de pago.
rejected_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de rechazo.
cancel_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de cancelación.
accreditation_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de acreditación.
review_validation_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de validación del pago por parte de la entidad.
payer_validation_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de validación del pago por parte del pagador.
payer_deferred_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Fecha de diferimiento del pago.
last_updated_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone

Última fecha de actualización.
metadataObject
Objeto JSON para adjuntar datos al pago.
carrierString
Carrier
sourceString

    idString
Identificador del origen.
    nameString
Nombre.
    typeString

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.
  • No labels