Descripción de la llamada.

Petición POST hacia https://www.gpfd.es/api/pago_documento.php


Codificación UTF8.


Parámetros de envio:


  • apikey: (Obligatorio) Identificador de envío de un administrador.
  • id: (Obligatorio si tipo y codigo no aparecen) Identificador interno del del documento dentro de la plataforma.
  • tipo:(Obligatorio si id no aparece)Tipo del documento (1,2,3).
  • codigo: (Obligatorio si id no aparece) Identificador del documento usado por la aplicación emisora. 
  • fecha_pago: (Obligatorio) Fecha del pago del documento: (DD/MM/AAAA)
  • medio_pago: (Obligatorio) Cadena de texto que indica el medio de pago utilizado.
  • cod_pago: (Opcional) Cadena de texto asignada al pago. Si el medio de pago devuelve algún identificador.


Respuesta al envío (jSON):

  • correcto: Valor booleano que indica el éxito de la petición.
  • error: Descripción del error.



Comportamiento de la API.

Recibida la petición se verifica si el apikey solicitado es válido para el envío de documentos, los documentos únicamente podrán ser pagados a través de las api si es un administrador.


Se comprueba:


  • que todos los campos obligatorios existen.
  • la integridad de cada campo.
  • si el id indicado existe en la plataforma.
  • si el tipo y codigo existe en la plataforma.
  • si el documento ya está como pagado previamente.



La identificación del documento puede ser bien por su id, o por el tipo y codigo interno, dando prioridad a su id en el caso de ser facilitado los dos.


Los errores pueden contener los siguientes mensajes:

  • "Usuario no identificado": Ocurre si no se ha comunicado el apikey, o este no es válido.
  • "Usuario no autorizado": El apikey es correcto, pero no se trata de un administrador.
  • "Información facilitada incorrecta": Falta algún campo obligatorio o hay alguno que no cumple los requisitos.
  • "Documento pagado": Cuando el documento ya se encuentra pagado.
  • "Documento inexistente": Cuando el documento no está disponible en la plataforma.



Código de ejemplo.

<!DOCTYPE html>
<html lang="es" dir="ltr">

<head>
    <meta charset="UTF-8">
    <title>Pago de documento</title>
</head>

<body>
    <Form action = "https://www.gpfd.es/api/pago_documento.php" method = "post">
        <label for="apikey">Api Key: </label><input type="text" name="apikey" value="34343ss" required="required"><br/>
        <label for="codigo">Código documento: </label><input type="number" name="codigo" value ="3"><br/>
        <label for="tipo">Tipo documento: </label><input type="text" name="tipo" value ="2"><br/>
        <label for="fecha_pago">Fecha de pago: </label><input type="text" name="fecha_pago" value ="01/01/2017"><br/>
        <label for="medio_pago">Medio de pago: </label><input type="text" name="medio_pago" value ="efectivo"><br/>
        <label for="cod_pago">Código de pago: </label><input type="text" name="cod_pago" value ="222"><br/>
        <input type="submit" value="enviar">
    </Form>
</body>
</html>