API Doc
Page tree

Versions Compared

Old Version 13

changes.mady.by.user Kevin Isersky

Saved on

compared with

New Version 14

changes.mady.by.user Kevin Isersky

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Preimportación

Acción

Status
colourBlue
titlePOST
    https://api.paypertic.com/importaciones/pagos


Este endpoint realiza una preimportación de los pagos presentados en un archivo csv. Devuelve como resultado una cabecera con los resultados generales del proceso. La importación inicia en estado PENDING, indicando que los pagos aún no fueron generados.

Parámetros del mensaje


Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
enableHighlightingfalse


NombreTipoFormatoDescripción
collector_idString

Identificador del comercio.

fileFile.CSV

Archivo que contiene cobranzas a importar con el formato requerido, sin los encabezados.

Status
colourRed
titleREQUERIDO

match_payerBooleantrue/falseFlag para filtrar suscripciones por referencia externa del pagador.
match_conceptBooleantrue/falseFlag para filtrar suscripciones por el concepto.
match_identificationBooleantrue/falseFlag para filtrar por identificación del pagador.


Si ambos flag son false o nulos, se filtrara las suscripciones por pagador.
Info
titleFlags

El request debe mandarse con por lo menos un flag en true.

Si se envía match_identification en true, match_payer y match_concept deben ir en false



Error posibles

  • 4000  Invalid request.

  • 4004  Invalid collector.

  • 4051  Unrelated collector.

  • 4100  Access denied.

  • 5001  Internal service error.

...

Este endpoint devuelve un listado con de las cabeceras de las importaciones de pagos realizadas por la entidad. Los resultados . Los registros pueden ser filtrados siguiendo el siguiente instructivo: Uso de filtros.

Los campos y operaciones disponibles para ser filtrados son lo los siguientes:

CampoOperaciones disponiblesAclaraciones
import_id
EQUAL

collector_id
EQUAL

status
EQUAL

status_code
EQUAL

request_date
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000

approved_date
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000
cancel_date
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000

Acción

Status
colourGreen
titleGET
  https://api.paypertic.com/importaciones/pagos/:import_id


Este endpoint devuelve la cabecera de la importación cuyo import_id sea enviado en la URL.

Detalle

Acción

Status
colourGreen
titleGET
  https://api.paypertic.com/importaciones/pagos/:import_id/detalles?

...

Este endpoint devuelve una lista con el del resultado de para cada registro pago de una importación. Debe especificarse su import_id en la URL. Los resultados registros pueden ser filtrados siguiendo el siguiente instructivo: Uso de filtros.

Los campos y operaciones disponibles para ser filtrados son lo los siguientes:

CampoOperaciones disponiblesAclaraciones
external_transaction_id
EQUAL
external_reference
EQUAL
concept_id
EQUAL
concept_description
CONTAINS
currency_id
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000

approved_date
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000
cancel_date
LESS_THAN 
GREATER_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

Formato esperado:

yyyyMMdd'T'hhmmss-0000
EQUAL
payer_reference
EQUAL
payer_name
CONTAINS
payer_email
EQUAL
payer_id_number
EQUAL
status
EQUAL
status_code
EQUAL

Aceptar/Cancelar una importación

Acción

Status
colourBlue
titlePOST
  https://api.paypertic.com/importaciones/pagos/aprobar/:import_id


Este endpoint aprueba la importación cuyo import_id sea enviado en la URL. Esto cambia su estado a APPROVED y genera los pagos que hayan sido preimportados exitosamente.

Acción

Status
colourBlue
titlePOST
  https://api.paypertic.com/importaciones/pagos/cancelar/:import_id


Este endpoint cancela la importación cuyo import_id sea enviado en la URL. Esto cambia su estado a CANCELLED sin generar pagos.