2. Genera Formato Pago Referenciado

Genera Formato Pago Referenciado

Introducción

El objetivo del documento es explicar el proceso de implementación del servicio web, sus métodos existentes y los parámetros de entrada y salida.

Este método al ingresar correctamente los parámetros de entrada obtiene la orden de pago así como también la línea de captura y la urlformatopago. Para realizar el pago correspondiente con los datos ingresados.

Url del Web service

https://apifinanzas.col.gob.mx/API/wsgeneraFormatoPagoReferenciado

Autenticación del Web service.

Para su correcto funcionamiento, el servicio web cuenta con autenticación de usuarios. Para ello, a cada responsable de la implementación de dicho servicio, se le proporcionarán los datos de usuario y contraseña.

Parámetros de entrada

El método del servicio web requiere invariablemente de los campos de usuario y contraseña, pero de manera independiente requiere de diferentes parámetros de entrada necesarios, los cuales se especifican a continuación:

Parámetros Tipo de dato Tamaño Descripción
folioSeguimiento String 20 máx. Folio de seguimiento del pago.
idTramite String 10 max. Id del trámite
importe decimal indefinido Importe a pagar.
nombre String 18 máx. Nombres del contribuyente.
apaterno String 50 máx. Apellido paterno del contribuyente.
amaterno String 50 máx. Apellido materno del contribuyente.
rfc String 13 máx. RFC (Registro Federal de Contribuyentes)
curp String 18 máx. CURP( La Clave Única de Registro de Población)
estado String 50 máx. Estado donde radica el contribuyente
municipio String 50 máx. Municipio del contribuyente.
poblacion String 50 máx. Población del Contribuyente.
colonia String 50 máx. Colonia del contribuyente.
calle String 50máx. Calle del contribuyente.
numero String 20 máx. Numero del contribuyente.
cp String 30 máx. Codigo postal.
Parámetros de salida
Parámetros Tipo de dato Tamaño Descripción
info json Máximo

Muestra el resultado de los siguientes parametros

  • folioSeguimiento.- Folio de seguimiento del pago.
  • folioControlEstado.- Folio de control del estado.
  • lineaCaptura.- Línea de captura generada para realizar el pago correspondiente
  • fechaVencimiento.- Fecha de vencimiento del trámite.
  • urlFormatoPago.- url del formato de pago.
  • codigo.- A continuación mostremos los diferentes códigos que nos regresa el método y su significado:
    • 2. id trámite obligatorio.
    • 3. id trámite incorrecto.
    • 4. folio seguimiento obligatorio.
    • 5. nombre obligatorio.
    • 6. nombre y apellido obligatorio.
    • 7. rfc inválido.
    • 8. curp invalida.
    • 9. estado obligatorio.
    • 10. municipio obligatorio.
    • 11. población obligatorio.
    • 12. colonia obligatorio.
    • 13. codigo postal obligatorio.
    • 14. codigo postal incorrecto.
  • mensaje.- Los mensajes que regresa el método al ejecutarlo son los siguientes:
    • Si no ingresa la curp mensaje.- curp invalida.
    • Si el parámetro de entrada nombre y apellido no es ingresados mensaje.- nombre y apellido obligatorio
    • Si la el método se ejecuta correctamente mensaje.- vacio y regresa los de más datos de salida con sus respetivas respuestas.
    • Si el parámetro de colonia no es ingresado al ejecutarlo mensaje.- colonia obligatorio
    • Si id de tramite es vacio es decir no es ingresado mensaje.- id trámite obligatorio.
    • Si folio de seguimiento no es ingresado mensaje.- folio seguimiento obligatorio.
    • Si el parámetro de rfc no tiene la longitud de 13 o 12 caracteres mensaje.- rfc inválido
    • Si codigo postal es ingresado vacio mensaje.- codigo postal invalido.
    • Si población esta vacio al ejecutar el método mensaje.-población obligatoria.