Integración SEPA

Parámetros de entrada:

Elemento	Contenido	Descripción
providerID		Obligatorio. El identificador único asignado por PAYCOMET para el proveedor de envío de operaciones SEPA. Disponible en el panel de control de clientes.
operations	Array	Obligatorio. Array de operaciones que se informan.

El array de operations deberá tener la siguiente forma:

Elemento	Contenido	Descripción
operationType	Tipos de operaciones: 2 – Transferencia (N34)	Obligatorio. Tipo de operación. Identifica la operación como transferencia.
merchantCode	[A-Za-z0-9]{1,8}	Obligatorio. Código de cliente. Se obtiene del panel de control.
terminalIDDebtor	[0-9]{1,5}	Obligatorio. Será el número de terminal asignado al producto. Se obtiene del panel de control. Identifica el número de terminal del ordenante en una operación SEPA.
uniqueIdCreditor	[a-zA-Z0-9]	Obligatorio. Será el identificador único de ese particular, autónomo, empresa beneficiaria en el cliente.
companyNameCreditor	[a-zA-Z0-9]	Obligatorio. Nombre de la empresa, particular o autónomo correspondiente al indicador anterior.
ibanNumberCreditor	[a-zA-Z0-9]	Obligatorio. Código IBAN de la cuenta del beneficiario.
swiftCodeCreditor	[a-zA-Z0-9]	Código SWIFT de la cuenta bancaria del beneficiario. Deberá proporcionarse cuando la cuenta IBAN no sea española. Si el número ibanNumberCreditor pertenece a una cuenta española, debe enviarse como string vacía.
companyTypeCreditor	[0-9]{1,3}	Obligatorio. Identificador del tipo de beneficiario: 1: Particular / 2: Autónomo / 3: Sociedad Mercantil.
operationOrder	[a-zA-Z0-9]	Referencia única de la operación.
operationAmount	[0-9]{1,8}	Obligatorio. Importe en la moneda de la transacción con 2 decimales en formato entero: (2,25 € = 225).
operationCurrency	[EUR][USD][GBP][JPY]	Obligatorio. Tipo de moneda de la transacción. La única divisa permitida es el euro, cuyo código es "EUR".
operationDatetime	[0-9]{yyyymmdd}	Obligatorio. Fecha en la que se quiere enviar la operación / remesa SEPA. Siempre posterior al día actual. Formato: yyyymmdd.
operationConcept	[A-Za-z0-9]|[+|?|\/|-|:|(|)|\.|,|'| ]{100}	Obligatorio. Concepto que se le asignará a la operación / remesa. Es el descriptor que aparecerá en los apuntes bancarios. Longitud máxima 100. Aunque el error 1273 especifica 140 caracteres, PAYCOMET reserva 40, de ahí que el máximo permitido en la entrada sea de 100.
operationSignature	[a-zA-Z0-9]	Obligatorio. Firma para comprobar la validez de esa operación. Se calculará conforme a lo expuesto en CÁLCULO DE LA FIRMA.

Parámetros de respuesta:

Elemento	Contenido	Descripción
operationResult	OK|KO	Resultado de la operación.
operationErrorCode	[0-9]{1-4}	En caso de operationResult KO, devuelve el ID del error obtenido. Ver CÓDIGOS DE ERROR.
operationOrder	[a-zA-Z0-9]	Referencia única de la operación.

array (size=2)
	0 => object(sepaOperationResponseClass)[7]
		public 'operationResult' => string 'OK' (length=2)
		public 'operationErrorCode' => string '' (length=0)
		public 'operationOrder' => string 'AV-PROD-TEST-9987023' (length=20)
	1 => object(sepaOperationResponseClass)[30]
		public 'operationResult' => string 'KO' (length=2)
		public 'operationErrorCode' => string '1026' (length=4)
		public 'operationOrder' => string 'AV-PROD-TEST-9987023' (length=20)

Cálculo firma

El cálculo de la firma para cada una de las operaciones que se quiera notificar se realizará de la siguiente forma:

En pseudocódigo:

En código PHP:

<?php
$plainSignature = ($operation->operationOrder . $operation->operationType . $operation->operationAmount . $operation->operationCurrency . $providerID . $merchantCode . $operation->terminalIDDebtor . $operation->uniqueIdCreditor . $operation->ibanNumberCreditor . $operation->swifCodeCreditor . $operation->companyTypeCreditor . $providerPassword);

$signature = strtoupper(hash('sha512', $plainSignature));

Ejemplo de inserción de operaciones SEPA

<?php
/**
 * Test para inserción de operaciones SEPA
 * Documentación y especificaciones: https://docs.paycomet.com/es/documentacion/sepa
 *
 * Tracking ID: BGD-2G6-2BB6
 *
 * @author PAYTPV ONLINE ENTIDAD DE PAGO, S.L.
 * @copyright Copyright (c) 2019, PAYTPV ONLINE ENTIDAD DE PAGO, S.L.
 * @version 1.0 2016-01-28
*/

date_default_timezone_set("Europe/Madrid");

$timeStart = microtime(true);

// Si se utiliza xdebug
ini_set("xdebug.var_display_max_data",-1);
ini_set("xdebug.var_display_max_children",-1);
ini_set("xdebug.var_display_max_depth",-1);

ini_set("soap.wsdl_cache_enabled", 0);
ini_set("soap.wsdl_cache_ttl", 0);
ini_set("soap.wsdl_cache_limit",0);

class sepaOperations {
	public $providerID			= 0;
	public $operationsArray		= array();
}

class operation {
	public $operationType;
	public $merchantCode;
	public $terminalIDDebtor;
	public $terminalIDCreditor;
	public $operationOrder;
	public $operationAmount;
	public $operationCurrency;
	public $operationDatetime;
	public $operationConcept;
	public $operationSignature;
}

$endPoint	= "https://api.paycomet.com/gateway/xml-sepa?wsdl";

$providerID	= "incluirProviderID";
$password	= "incluirProviderPassword";

$client = new SOAPClient($endPoint);

$numOperations	= 1; // Ejemplo para una operación

//-------------------------------------------------------------- sepaOperations ------------------------------------------------------------------->

$arrOperations	= array();

for ($n=1;$n<=$numOperations;$n++) {

	$operation = new operation();

	$operation->operationType		= "2";                                                                      // 2: Transferencia (N34)
	$operation->merchantCode		= "incluirMerchantCode";                                                    // Código de cliente. Se obtiene del panel de control.
	$operation->terminalIDDebtor	= "incluirTerminalIdDelDeudor";                                             // Será el número de terminal asignado al producto. Se obtiene del panel de control.
	$operation->uniqueIdCreditor	= "incluirIdentificadorUnicoDeClienteEnVuestroSistema";                     // Será el identificador único de ese particular, autónomo, empresa en vuestro sistema
	$operation->companyNameCreditor = "incluirNombreDeCliente";                                                 // Nombre de la empresa, particular o autónomo correspondiente al indicador anterior
	$operation->ibanNumberCreditor	= "incluirIBANValido";                                                      // Código IBAN de la cuenta del beneficiario.
	$operation->swiftCodeCreditor	= "";                                                                       // Código SWIFT de la cuenta bancaria del beneficiario. Recomendable en cuentas IBAN no españolas.
	$operation->companyTypeCreditor = 3;                                                                        // 1: Particular, 2: Autónomo, 3: Sociedad Mercantil
	$operation->operationOrder		= "SEPA TRANSFER-".date("Ymd H:i:s") . substr((string)microtime(), 1, 8);   // Referencia única de la operación.
	$operation->operationAmount		= "1000";                                                                   // Importe en la moneda de la transacción con 2 decimales en formato entero: (2,25 € = 225).
	$operation->operationCurrency	= "EUR";                                                                    // Tipo de moneda de la transacción. La única divisa permitida es el euro, cuyo código es "EUR"
	$operation->operationDatetime	= "20190712";                                                               // yyyyymm, fecha en la que se quiere enviar la operación / remesa SEPA. Siempre posterior al día actual
	$operation->operationConcept	= "Transferencia de XXXXXXXXX - a XXXXXXXXX: ".rand(0,9999);                // Descriptor que aparecerá en los apuntes bancarios. Longitud máxima 100 caracteres

	// Cálculo de firma
	$plainSignature = ($operation->operationOrder.$operation->operationType.$operation->operationAmount.$operation->operationCurrency.$providerID.$operation->merchantCode.$operation->terminalIDDebtor.$operation->uniqueIdCreditor.$operation->ibanNumberCreditor.$operation->swiftCodeCreditor.$operation->companyTypeCreditor.$password);
	$signature = strtoupper(hash("sha512" ,$plainSignature));
	$operation->operationSignature	= $signature;

	// Porque en caso de arrays de un solo elemento, no asigna $key numérica.
	$arrOperations[$n] = $operation;
}

//--------------------------------------------------------------->

$postData = new sepaOperations();

$postData->providerID		= $providerID;
$postData->operationsArray	= $arrOperations;
var_dump($arrOperations);

$timeRequest = microtime(true);

$response = $client->sepaOperations($postData->providerID, $postData->operationsArray);

$timeResponse = microtime(true);

var_dump($response);

$time = $timeResponse - $timeRequest;
echo "
Número de peticiones: $numOperations -  Respuesta en $time";

$timeEnd = microtime(true);

?>

Parámetros de entrada:

Elemento	Contenido	Descripción
providerID		Obligatorio. El identificador único asignado por PAYCOMET para el proveedor de envío de operaciones SEPA. Disponible en el panel de control de clientes.
merchantCode	[A-Za-z0-9]{1,8}	Obligatorio. Código de cliente. Se obtiene del panel de control.
terminalIDDebtor	[0-9]{1,5}	Obligatorio. Será el número de terminal asignado al producto. Se obtiene del panel de control. Identifica el número de terminal del ordenante en una operación SEPA.
operationOrder	[a-zA-Z0-9]	Referencia única de la operación.
operationSignature	[a-zA-Z0-9]	Obligatorio. Firma para comprobar la validez de esa operación. Se calculará conforme a lo expuesto en CÁLCULO DE LA FIRMA.

Parámetros de respuesta:

Elemento	Contenido	Descripción
operationResult	OK|KO	Resultado de la operación.
operationErrorCode	[0-9]{1-4}	En caso de operationResult KO, devuelve el ID del error obtenido. Ver CÓDIGOS DE ERROR.
operationOrder	[a-zA-Z0-9]	Referencia única de la operación.

Cálculo firma

El cálculo de la firma para cada una de las operaciones que se quiera notificar se realizará de la siguiente forma:

En pseudocódigo:

En código PHP:

<?php
$plainSignature = ($operation->operationOrder . $providerID . $merchantCode . $operation->terminalIDDebtor . $providerPassword)

Parámetros de entrada:

Elemento	Contenido	Descripción
SEPA_PROVIDER_ID	[A-Za-z0-9]	Identificador único asignado por PAYCOMET para el proveedor de envío de operaciones SEPA. Disponible en el panel de control de clientes.
MERCHANT_CODE	[A-Za-z0-9]{1,8}	Identificador único como cuenta en PAYCOMET. Disponible en el panel de control de clientes.
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[a-zA-Z0-9]	Número de cuenta del cliente en formato IBAN.
DOCUMENT_TYPE	[0-9]	Identificador del tipo de documento en PAYCOMET. Ver TIPOS DE DOCUMENTO.
FILE_CONTENT	[A-Za-z0-9]	Contenido binario del fichero a enviar, codificado en base 64.
SIGNATURE	[A-Za-z0-9]	Firma de la petición. Ver CÁLCULO DE LA FIRMA.

Parámetros de respuesta:

Elemento	Contenido	Descripción
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[A-Za-z0-9]	Número de cuenta del cliente en formato IBAN.
DOCUMENT_TYPE	[0-9]	Identificador del tipo de documento en PAYCOMET. Ver TIPOS DE DOCUMENTO.
DOCUMENT_STATUS	[0-9]	Identificador del estado del documento. Ver ESTADOS DE DOCUMENTO
ERROR_ID	[0-9]	En caso de error, devuelve el identificador del error obtenido. Ver CÓDIGOS DE ERROR.

Cálculo firma add_document

El cálculo de la firma para la petición se realizará de la siguiente forma:

PHP

<?php
$data['SIGNATURE'] = hash('sha512', $data['SEPA_PROVIDER_ID'] . $data['MERCHANT_CODE'] . $data['MERCHANT_CUSTOMER_ID'] . $data['MERCHANT_CUSTOMER_IBAN'] . $data['DOCUMENT_TYPE'] . $providerPassword);

Parámetros de entrada:

Elemento	Contenido	Descripción
SEPA_PROVIDER_ID	[A-Za-z0-9]	Identificador único asignado por PAYCOMET para el proveedor de envío de operaciones SEPA. Disponible en el panel de control de clientes.
MERCHANT_CODE	[A-Za-z0-9]{1,8}	Identificador único como cuenta en PAYCOMET. Disponible en el panel de control de clientes.
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[A-Za-z0-9]	Número de cuenta del cliente en formato IBAN.
DOCUMENT_TYPE	[0-9]	Identificador del tipo de documento en PAYCOMET. Ver TIPOS DE DOCUMENTO.
SIGNATURE	[A-Za-z0-9]	Firma de la petición. Ver CÁLCULO DE LA FIRMA.

Parámetros de respuesta:

Elemento	Contenido	Descripción
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[A-Za-z0-9]	Número de cuenta del cliente en formato IBAN.
DOCUMENT_TYPE	[0-9]	Identificador del tipo de documento en PAYCOMET. Ver TIPOS DE DOCUMENTO.
DOCUMENT_STATUS	[0-9]	Identificador del estado del documento. Ver ESTADOS DE DOCUMENTO
ERROR_ID	[0-9]	En caso de error, devuelve el identificador del error obtenido. Ver CÓDIGOS DE ERROR.

Cálculo firma check_document

El cálculo de la firma para la petición se realizará de la siguiente forma:

PHP

<?php
$data['SIGNATURE'] = hash('sha512', $data['SEPA_PROVIDER_ID'] . $data['MERCHANT_CODE'] . $data['MERCHANT_CUSTOMER_ID'] . $data['MERCHANT_CUSTOMER_IBAN'] . $data['DOCUMENT_TYPE'] . $providerPassword);

Parámetros de entrada:

Elemento	Contenido	Descripción
SEPA_PROVIDER_ID	[A-Za-z0-9]	Identificador único asignado por PAYCOMET para el proveedor de envío de operaciones SEPA. Disponible en el panel de control de clientes.
MERCHANT_CODE	[A-Za-z0-9]{1,8}	Identificador único como cuenta en PAYCOMET. Disponible en el panel de control de clientes.
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[A-Za-z0-9]	Número de cuenta del cliente en formato IBAN.
MERCHANT_CUSTOMER_TYPE	[0-9]	Identificador del tipo de figura jurídica en PAYCOMET. 1: Particular / 2: Autónomo / 3: Sociedad Mercantil.
SIGNATURE	[A-Za-z0-9]	Firma de la petición. Ver CÁLCULO DE LA FIRMA.

Parámetros de respuesta:

Elemento	Contenido	Descripción
MERCHANT_CUSTOMER_ID	[A-Za-z0-9]	Identificador único del cliente del proveedor.
MERCHANT_CUSTOMER_IBAN	[A-Za-z0-9]	Número de cuenta del cliente en formato IBAN.
DOCUMENTS	[A-Za-z0-9]	Cadena de texto en formato JSON con la información del estado de los documentos. La información contiene el identificador del tipo de documento y un valor booleano para identificar si está verificado o no. Ver TIPOS DE DOCUMENTO.
ERROR_ID	[0-9]	En caso de error, devuelve el identificador del error obtenido. Ver CÓDIGOS DE ERROR.

Cálculo firma check_customer

El cálculo de la firma para la petición se realizará de la siguiente forma:

PHP

<?php
$data['SIGNATURE'] = hash('sha512', $data['SEPA_PROVIDER_ID'] . $data['MERCHANT_CODE'] . $data['MERCHANT_CUSTOMER_ID'] . $data['MERCHANT_CUSTOMER_IBAN'] . $providerPassword);

Ejemplo para añadir y comprobar documentos SEPA

<?php
/**
 * Test para añadir y comprobar documentos SEPA
 * Documentación y especificaciones: https://docs.paycomet.com/es/documentacion/sepa
 *
 * @author PAYCOMET
 * @copyright Copyright (c) 2020, PAYCOMET
 */

date_default_timezone_set("Europe/Madrid");

ini_set("soap.wsdl_cache_enabled", "0");
ini_set("soap.wsdl_cache_ttl", "0");

$endpoint = "https://api.paycomet.com/gateway/xml-sepa-documentation?wsdl";

$context = stream_context_create([
    "ssl" => [
        "verify_peer" => false,
        "verify_peer_name" => false,
        "allow_self_signed" => true
    ]
]);

$options = [
    "use" => "literal",
    "stream_context" => $context
];

########################
##### add_document #####
########################
$fileContent = base64_encode(
    file_get_contents("path_to_file.pdf")
);

$params = [];
$params["SEPA_PROVIDER_ID"] = "*** YOUR PROVIDER ID ***";
$params["MERCHANT_CODE"] = "*** YOUR MERCHANT CODE ***";
$params["MERCHANT_CUSTOMER_ID"] = "*** YOUR CUSTOMER ID";
$params["MERCHANT_CUSTOMER_IBAN"] = "ES*******************";
$params["DOCUMENT_TYPE"] = "*** YOUR DOCUMENT TYPE ID ***";
$params["FILE_CONTENT"] = $fileContent;

$providerPassword = "*** YOUR PROVIDER PASSWORD ***";
$params["SIGNATURE"] = hash("sha256", $params["SEPA_PROVIDER_ID"] . $params["MERCHANT_CODE"] . $params["MERCHANT_CUSTOMER_ID"] . $params["MERCHANT_CUSTOMER_IBAN"] . $params["DOCUMENT_TYPE"] . $providerPassword);

$client = new SoapClient($endpoint, $options);
$response = $client->add_document($params["SEPA_PROVIDER_ID"], $params["MERCHANT_CODE"], $params["MERCHANT_CUSTOMER_ID"], $params["MERCHANT_CUSTOMER_IBAN"], $params["DOCUMENT_TYPE"], $params["FILE_CONTENT"], $params["SIGNATURE"]);
var_dump($response);
die();


##########################
##### check_document #####
##########################
$params = [];
$params["SEPA_PROVIDER_ID"] = "*** YOUR PROVIDER ID ***";
$params["MERCHANT_CODE"] = "*** YOUR MERCHANT CODE ***";
$params["MERCHANT_CUSTOMER_ID"] = "*** YOUR CUSTOMER ID";
$params["MERCHANT_CUSTOMER_IBAN"] = "ES*******************";
$params["DOCUMENT_TYPE"] = "*** YOUR DOCUMENT TYPE ID ***";
$providerPassword = "*** YOUR PROVIDER PASSWORD ***";
$params["SIGNATURE"] = hash("sha256", $params["SEPA_PROVIDER_ID"] . $params["MERCHANT_CODE"] . $params["MERCHANT_CUSTOMER_ID"] . $params["MERCHANT_CUSTOMER_IBAN"] . $params["DOCUMENT_TYPE"] . $providerPassword);

$client = new SoapClient($endpoint, $options);
$response = $client->check_document($params["SEPA_PROVIDER_ID"], $params["MERCHANT_CODE"], $params["MERCHANT_CUSTOMER_ID"], $params["MERCHANT_CUSTOMER_IBAN"], $params["DOCUMENT_TYPE"], $params["SIGNATURE"]);
var_dump($response);
die();