Permite insertar un pago independiente de cualquier factura junto con un documento que podrá ser firmado; este método sólo devuelve una URL de pago que puede es ser embebida en una web redireccionando a la pasarela de pago.
Parámetro de entrada necesarios
El servicio recibe los siguientes parámetros:
Parámetros
Tipo de dato
Requerido
Descripción
idClient
Alfanumérico
Si
Identificador del cliente
idPago
Alfanumérico
Si
Refencia del pago
importe
Decimal
Si
Importe total a cobrar
fechaVencimiento
Alfanumérico
No
Fecha de vencimiento del pago (YYYY-MM-DD)
descripcionPago
Alfanumérico
Si
Concepto del pago
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
tipoPago
Alfanumérico
No
Indica el tipo de pago que requiera. Posibles valores: AU (Autorización), PN(Default, Pago no recurrente), RI (Recurrente inicial)
pagoParcial
Boolean
No
Indica si admite pago parcial
importeMinimo
Decimal
No
Importe mínimo del pago parcial
importaMaximo
Decimal
No
Importe máximo del pago parcial
lenguaje
Alfanumérico
No
Lenguaje por defecto de la pantalla de pago
metodosPago
Alfanumérico
No
Listado de métodos de pago separados por «;» (Ver tabla de métodos de pago)
idDeudor
Numérico
No
Campo para identificar al deudor
metadata
Alfanumérico
Si
Campo que viaja a Pasarela como METADATA
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
Lenguajes
Opción
Código ISO-639-1
Español
es
Catalán
ca
Inglés
en
Polaco
pl
Portugués
pt
Parámetros de salida
El servicio devolverá un mensaje JSON con los siguientes campos:
Campo
Valor
resultado
OK/KO
error
ErrorPago(Ver tabla)
urlPago
url generada para ese pago
idPago
Ref de pago enviado
tokenPago
ID generado para ese pago
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 generar URL de pago
6
Importe incorrecto
7
ErrorFormatoUrlOK
8
ErrorFormatoUrlKO
Métodos de pago
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 ellos se generará una cadena concatenados los siguientes valores:
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)))
El resultado de esta función es el valor a enviar en el campo firma
Ejemplo de petición
Ejecutamos el método New mediante una invocación POST al servicio en el entorno de test:
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étodo de pago
infoPago
Información del pago
fechaExpiracion
Fecha expiración tarjeta
tokenTarjeta
Token tarjeta
tipotarjeta
Tipo tarjeta
paisTarjeta
País tarjeta
bancoOperacion
Código operación banco
divisa
Código divisa
indiceDivisa
Indice divisa
divisaPago
Pago divisa
numeroIdentidadPersona
Identificador de pago/factura
titularTarjeta
Nombre titular tarjeta
metadata
metadata
tarjetaPresente
Identifica si el pagador está presente
responseTime
Fecha (yyyyMMddHHmmssfff)
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)))
El resultado de esta función es el valor a enviar en el campo firma