Inserta un pago independiente de cualquier factura, junto con un documento, que será firmado y devolverá una URL de pago, que redirecciona a la pasarela de pago
Parámetros de entrada necesarios
El servicio recibe los siguientes parámetros:
Parámetro
Tipo de dato
Requerido
Descripción
idCliente
Alfanumérico
Si
Identificador del cliente
idPagoDoc
Alfanumérico
Si
Ref. del pago
importe
Decimal
Si
Importe total a cobrar
fechaVencimiento
Alfanumérico
No
Fecha vencimiento del pago (YYYY-MM-DD)
descripciónPago
Alfanumérico
Si
Concepto de pago
nombre
Alfanumérico
Si
Nombre
apellido1
Alfanumérico
Si
Primero apellido
apellido2
Alfanumérico
No
Segundo apelido
telefono
Alfanumérico
Si
Teléfono para recibir SMS
CIF
Alfanumérico
Si
CIF
Email
Alfanumérico
Si
Email para recibir documento firmado
moneda
Alfanumérico
No
Por defecto (“EUR”)
urlPagoOK
Alfanumérico
No
URL redirección pago OK
urlPagoKO
Alfanumérico
No
URL redirección pago KO
pagoParcial
Verdadero/Falso
No
Indica si admite pago parcial
importeMinimo
Decimal
No
Importe mínimo del pago parcial
importeMaximo
Decimal
No
Importe máximo del pago parcial
tipoPago
Alfanumérico
No
Indica el tipo de pago que requiera. Posibles valores: AU (Autorización), PN(Default, Pago no recurrente), RI (Recurrente inicial)
metodosPago
Alfanumérico
No
Listado de métodos de pago separados por “;” (Ver tabla métodos de pago)
idDeudor
Decimal
No
Campo para identificar al deudor
enviarComunicacion
Boolean
Si
Deberá ir a «true» para realizar el envío del documento al cliente
marcaDeFirma
Alfanumerico
Si
%FIRMADOCUMENTO%
anchoFirma
Entero
No
Tamaño de ancho que se le asignará a la firma en el documento en cm. Ej: 157
altoFirma
Entero
No
Tamaño de alto que se le asignará a la firma en el documento en cm. Ej: 75
metadata
Alfanumérico
Si
Campo que viaja a Pasarela como METADATA
infoExtra
Alfanumérico
Si
Información extra para pasarela
dataDocument
dataDocument
/
Estructura de fichero
firma
Alfanumérico
Si
Firma generada con los campos y la clave privada
Si la fecha de vencimiento no se especifica, se le sumarán 7 días a la fecha en la que se reciba el pago
Si se realiza un pago parcial, este cobro queda finalizado habiéndose cobrado solo una parte de la deuda exigida. Para terminar de cobrar el pago total, se deberá de generar un pago diferente con el importe que queda pendiente, por lo tanto la URL generada para el pago original solo podrá ser usada una vez
El formato del idioma debe ser el ISO-639-1. Si no se especifica el lenguaje, se establecerá el español por defecto
Valores permitidos para el lenguaje de la pantalla de pago:
Opción
Código ISO-639-1
Español
es
Catalán
ca
Inglés
en
Polaco
pl
Portugués
pt
El contenido del documento se enviará codificado en Base64.
Campo
Tipo
nombreDoc
Alfanumérico
contenidoDoc
Alfanumérico (contenido del fichero en Base64)
mimeType
Alfanumérico /Opcional
Parámetros de salida
El servicio devolverá un mensaje JSON con los siguientes campos:
Campo
Tipo
nombreDoc
Alfanumérico
contenidoDoc
Alfanumérico (contenido del fichero en Base64)
mimeType
Alfanumérico /Opcional
Dónde:
Error: código de resultado de error que devolverá los valores indicados en la siguiente tabla:
Valor
Descripción
0
Sin error
1
Datos requeridos
2
Formato fecha
3
Error validación de datos
4
Identificador erróneo
5
Error al general URL de pago
6
Importe incorrecto
7
ErrorFormatoUrlOK
8
ErrorFormatoUrlKO
13
idPago duplicado
Posibles valores para el campo:
metodosPago
Método
Valor
Card (Tarjeta bancaria)
0
BIZUM
2
PAYPAL
3
ARCOPAY (Transferencia B.)
7
El campo firma se compondrá mediante el siguiente proceso:
Para ello hay que construir una cadena concatenando los siguientes valores:
El campo firma se ha compuesto de la siguiente manera:
Creamos la cadena de firma: – BB9E34635FB7BB9E34635FB72020-09-12CONTRATO MES JULIOC35C7EE710D3
Generamos el hash para esa cadena, lo convertimos a una cadena hexadecimal y lo ponemos en mayúsculas: – 33A25F04EA776D840863C6AE62EDCFA35E2E72841E27E89D058A44954B134AF2
Respuesta a una petición
La petición anterior devolverá una respuesta JSON con el siguiente contenido:
Al recibir la notificación de un pago realizado, se enviará un JSON con la información a la URL de callback que se haya especificado por cliente.
La respuesta tendrá los siguientes datos:
Campo
Valor
estado
EstadoPago (Ver tabla)
idPago
Nº indicado al crear el pago
tokenPago
ID interno al crear el pago
fechaPago
Fecha del pago
importeExigido
Importe de la factura
importePagado
Importe pagado
codigoAutorizacion
Código autorización del pago
codigoInterno
Código comercio
codigoOperacion
Código de operación del pago
tipoEvento
Tipo de evento de la respuesta (Ver tabla)
metodoPago
Métodos de pago
infoPago
Información del pago
fechaExpiracion
Fecha expiración tarjeta
tokenTarjeta
Token tarjeta
tipoTarjeta
Tipo de tarjeta
paisTarjeta
País de emisión de la tarjeta
bancoOperacion
Código de operación del banco
divisa
Código divisa
indiceDivisa
Indice divisa
divisaPago
Pago divisa
numeroIdentidadPersona
Identificador del pagador
titularTarjeta
Nombre titular tarjeta
metadata
metadata
tarjetaPresente
Identifica si el pagador esta presente (True o false)
responseTime
Fecha (yyyyMMddHHmmssffff)
firma
Firma de la petición
Dónde:
Estado: Código de los posibles estados del pago:
estadoFactura
Código
Estado
0
Activo
1000
ConPagoParcial
1001
Cobrado
1002
AnuladoPorCobro
3
Retirado
4
Reemplazado
5
ErrorYaCobrado
6
Sobrescrito
Posibles valores para el campo:
tipoEvento
Código
Estado
0
pmt_begin
1
pmt_ok
2
pmt-ko
El campo firma se compondrá mediante el siguiente proceso. Para ellos se generará una cadena concatenados los siguientes valores:
idCliente CIF responseTime
Sobre esta cadena, aplicaremos una función SHA 256 y el resultado será codificado en una cadena hexadecimal (en Mayúsculas) firma = upper(hex(sha256(cadena de firma)))