Saltar al contenido principal
Documentación de Paylands

Documentación de Paylands (1.0.0)

Download OpenAPI specification:Download

Alguna pregunta? Contacta con nosotros aquí: soporte@paylands.com

Autenticación

Cuando uses la presente API deberás autenticar las llamadas mediante tu API Key en cada petición. Tu API Key conlleva muchos privilegios por lo que asegúrate de mantenerla en secreto. No compartas tu API Key ni la expongas nunca en el código del lado del cliente de cualquier sitio web público.

La autenticación de la API se realiza mediante HTTP Basic Auth. Provee tu API Key como valor para el campo username (nombre de usuario). No es necesario proveer valor para el campo password (contraseña). Si se setea la cabecera Basic Auth manualmente, la API Key debe ir codificada en base64.

Si necesita autenticar via bearer auth (como por ejemplo, para una petición cross-origin), usa el modificador -H "Authorization: Bearer " en lugar de -u :.

Todas las peticiones a la API deben realizarse sobre HTTPS. Las peticiones realizadas sobre HTTP serán denegadas; así como las peticiones sin autenticar.

Autenticación de peticiones

Ejemplo de como autenticar todas las peticiones a la API.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "OK",
  • "current_time": "2019-05-30T12:55:48+0200"
}

API Keys

Ver los perfiles de mi API key

Este endpoint sirve para obtener los perfiles de la API key que se ha usado en la petición. Si la API key tiene acceso total, se devolverá el perfil all.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2019-05-30T12:55:48+0200",
  • "message": "OK",
  • "profiles": [
    ]
}

Obtener perfiles API key

Este endpoint sirve para obtener todos los perfiles que puede tener una API key.

  • all: Acceso total
  • payment: Creación de órdenes, pagos, devoluciones, confirmaciones, cancelaciones, tokenización de tarjetas
  • refund: Devolver órdenes.
  • readonly: Leer órdenes, clientes, tarjetas, etc,
  • card: Tokenizar, listar, modificar y borrar tarjetas
  • tokenize: Tokenizar tarjetas
  • moto: Lanzar campañas MoTo
  • batch_authorization: Lanzar pagos en lote
  • batch_refund: Lanzar devoluciones en lote
  • keyentry: Procesar pagos manuales
header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2019-05-30T12:55:48+0200",
  • "message": "OK",
  • "profiles": [
    ]
}

Pagos

Generar Orden de pago

Generar Orden de pago

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

amount
required
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

operative
required
string
Enum: "AUTHORIZATION" "DEFERRED" "PAYOUT" "TRANSFER"

Operativa de la orden que se usará en el pago.

secure
required
boolean

true si el pago requerirá 3D Secure. false en caso contrario.

customer_ext_id
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

service
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

description
required
string

Descripción del pago. Para los pagos mediante transferencia bancaria, el concepto que verá el usuario será el indicado en este campo.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

url_post
string

URL que recibirá una notificación HTTP indicando el estado final del pago.

url_ok
string

URL a la cual se redirigirá el usuario tras el pago si pudo ser cobrado con éxito.

url_ko
string

URL a la cual se redirigirá el usuario tras el pago si no pudo ser cobrado.

template_uuid
string

Plantilla de la carta de pago que se le mostrará al cliente. Si el valor es "null" se utilizara la plantilla por defecto.

dcc_template_uuid
string Nullable

Plantilla del DCC que se le mostrará al cliente. Si el valor es null se utilizara la plantilla por defecto.

source_uuid
string

Identificador único del medio de pago empleado para realizar el pago.

save_card
boolean
Default: true

Indica si el usuario ha dado consentimiento para que su tarjeta sea usada en pagos futuros. La tarjeta puede usarse para procesar pagos con independencia de este valor, es el comercio quien debe tener en cuenta este campo.

reference
string Nullable

Referencia de la orden. Puede ser utilizado como identificador externo o para evitar pagos duplicados.

dynamic_descriptor
string Nullable

Descriptor dinámico del cargo en la cuenta bancaria del cliente. Puede no concordar exactamente con este valor.

expires_in
number [ 600 .. 31536000 ] Nullable
Default: 600

Tiempo en segundos desde que se crea la orden hasta que expira.

object (ExtraData)

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "amount": 100,
  • "operative": "AUTHORIZATION",
  • "secure": true,
  • "customer_ext_id": "test",
  • "service": "9A1BDCC8-DB30-4ED2-8523-62B330A67873",
  • "description": "Payment #1",
  • "additional": null,
  • "template_uuid": "6412549E-933E-4DFE-A225-2E87FBF7623E",
  • "dcc_template_uuid": "BF418CA6-7043-4864-B36F-F02C2CF2B76B",
  • "source_uuid": null,
  • "save_card": true,
  • "reference": "50620",
  • "dynamic_descriptor": "PNP*NombreComercio",
  • "expires_in": 3600,
  • "extra_data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T15:29:49+0100",
  • "order": {
    },
  • "client": {
    },
  • "extra_data": {
    },
  • "validation_hash": "5fb245ebd2bea93d38212c7cd9a74ad18cdbc4036cc674d225bead28fc784f90"
}

Enviar enlace de orden de pago por SMS/Email

Este endpoint envía el enlace de la orden de pago por SMS o correo electrónico a su destinatario, según proceda.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

destination
required
string

La dirección de email o el número móvil al que se le enviará la orden de pago.

subject
required
string

Título del mensaje.

template_uuid
string

Plantilla de la carta de pago que se le mostrará al cliente. Si el valor es "null" se utilizara la plantilla por defecto.

language
string

El idioma usado durante el proceso de pago en formato ISO 639-1.

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "order_uuid": "1F405EA3-9798-42A6-9E87-BD347EF67F55",
  • "destination": "name@example.com",
  • "subject": "Título del mensaje",
  • "template_uuid": "6412549E-933E-4DFE-A225-2E87FBF7623E",
  • "language": "es"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:51:27+0100",
  • "delivery": true
}

Pago en un sólo paso

Permite generar una orden de cobro, almacenar la tarjeta y realizar el pago en una sola petición. Sólo usable por clientes PCI.

Si el pago es no seguro se realizará un pago directo. En caso de que el antifraude detecte riesgo, se devolverá un enlace para que el usuario finalice el pago tokenizado por 3DS, de lo contrario el pago finalizará normalmente.

Si el pago es seguro se devolverá el enlace al pago tokenizado por 3DS para que el usuario finalice el pago de forma segura.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

amount
required
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

operative
required
string
Enum: "AUTHORIZATION" "DEFERRED" "PAYOUT" "TRANSFER"

Operativa de la orden que se usará en el pago.

secure
required
boolean

true si el pago requerirá 3D Secure. false en caso contrario.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

service
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

description
required
string

Descripción del pago. Para los pagos mediante transferencia bancaria, el concepto que verá el usuario será el indicado en este campo.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

url_post
string

URL que recibirá una notificación HTTP indicando el estado final del pago.

url_ok
string

URL a la cual se redirigirá el usuario tras el pago si pudo ser cobrado con éxito.

url_ko
string

URL a la cual se redirigirá el usuario tras el pago si no pudo ser cobrado.

template_uuid
string

Plantilla de la carta de pago que se le mostrará al cliente. Si el valor es "null" se utilizara la plantilla por defecto.

dcc_template_uuid
string Nullable

Plantilla del DCC que se le mostrará al cliente. Si el valor es null se utilizara la plantilla por defecto.

card_holder
required
string

Titular de la tarjeta.

card_pan
required
string

Número de la tarjeta.

card_expiry_month
required
string

Mes de expiración de la tarjeta.

card_expire_year
string

Año de expiración de la tarjeta.

card_additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

card_cvv
string

Número de verificación que aparece normalmente en el reverso de la tarjeta.

customer_ip
string

IP del usuario.

reference
string Nullable

Referencia de la orden. Puede ser utilizado como identificador externo o para evitar pagos duplicados.

dynamic_descriptor
string Nullable

Descriptor dinámico del cargo en la cuenta bancaria del cliente. Puede no concordar exactamente con este valor.

expires_in
number [ 600 .. 31536000 ] Nullable
Default: 600

Tiempo en segundos desde que se crea la orden hasta que expira.

object Nullable

Campo que contiene la información procedente del comercio si ha indicado una autenticación mediante MPI/3DS externo.

object (ExtraData)

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "amount": 100,
  • "operative": "AUTHORIZATION",
  • "secure": false,
  • "customer_ext_id": "test",
  • "service": "9A1BDCC8-DB30-4ED2-8523-62B330A67873",
  • "description": "Payment #1",
  • "additional": null,
  • "template_uuid": "6412549E-933E-4DFE-A225-2E87FBF7623E",
  • "dcc_template_uuid": "BF418CA6-7043-4864-B36F-F02C2CF2B76B",
  • "card_holder": "Jose",
  • "card_pan": "4761739000060016",
  • "card_expiry_month": "12",
  • "card_expiry_year": "21",
  • "card_additional": "Card additional",
  • "card_cvv": "123",
  • "customer_ip": "127.0.0.1",
  • "reference": "50620",
  • "dynamic_descriptor": "PNP*NombreComercio",
  • "threeds_data": {
    },
  • "expires_in": 3600
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:24:26+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "88e0b4e4ca902beb6df70693a0a94164be0485bab865dc168e3a1bf6bf5a71f7"
}

Bizum

El usuario es redirigido a la página de pago de Bizum, donde deberá introducir el número de teléfono de la cuenta desde donde desea pagar.

Esta modalidad de pago solo está disponible en REDSYS y será necesario activarlo previamente: póngase en contacto con soporte para activar esta configuración.

En el entorno SANDBOX, se puede simular pagos exitosos o rechazados utilizando los siguientes valores como número de teléfono, cuando se solicite:

  • Pago exitoso: 700000000
  • Pago rechazado: ko@ko.ko
path Parameters
token
required
string
Example: ebc9b5ffa2efcf74197734a071192817e6f2a3fc15f49c4b1bdb6edc46b16e3ab4109498bff8e6ba00fb6d2bd1838afbea67095c4caaa2f46e4acf4d5851884c

El token de la orden.

Responses

Response samples

Content type
text/html

Cancelación

Mediante esta operativa se libera el saldo retenido por una operación DEFERRED.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:00:42+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "e9e97e6514c2a2e2367207c4f39c25e6feb852788c412ec9814fa2a49c7cad57"
}

Confirmación

Mediante esta operativa se confirma el saldo retenido por una operación DEFERRED.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

amount
number

Importe enviado para la operación. Si no se indica, la confirmación es total. Puede indicarse si el servicio permite confirmar parcialmente.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55",
  • "amount": 100
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:06:17+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "b34f457d184499c182f2066337aef97e568a6813fd50b0d23a9af88c921cb4d0"
}

Por WebService

En este método de pago no interviene el usuario. Para ello se necesita el uuid de la orden de pago y el uuid de una tarjeta previamente almacenada en el sistema.

Si el comercio tiene el sistema antifraude activado, podría darse el caso que alguna regla se activase y fuese necesario finalizar el cobro por 3DS. En este caso, la respuesta devuelta contendrá la URL a la que debe redirigirse al usuario para autenticarse y poder finalizar el cobro.

Bajo ningún concepto debe modificarse esta URL, puesto que su formato puede variar en futuras actualizaciones. Su uso se restringe a obtenerla del cuerpo de la petición y redirigir al usuario.

La IP del usuario que solicita el pago debe indicarse en formato IPv4 o IPv6. Si no se indica, no se podrán ejecutar medidas antifraude relacionadas con la IP.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

card_uuid
required
string

Identificador de la tarjeta.

customer_ip
string

IP del usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1F405EA3-9798-42A6-9E87-BD347EF67F55",
  • "card_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "customer_ip": "62.43.214.55"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:51:27+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "88e0b4e4ca902beb6df70693a0a94164be0485bab865dc168e3a1bf6bf5a71f7"
}

Pago MoTo por API

Este método permite realizar el pago de una orden con los datos de pago obtenidos mediante correo o teléfono. Esta operación no requerirá autenticación, ya que es una operación exenta de PSD2. Sólo usable por clientes PCI.

En caso de tener activado el antifraude, las órdenes consideradas de riesgo se procesarán sin ninguna restricción adicional.

Para llevar a cabo este pago será necesario indicar la tarjeta que se va a emplear. Hay dos formas para ello: indicando los datos de tarjeta por separado (card_holder, card_pan, card_expire_month, card_expire_year, y opcionalmente, con card_cvv y card_additional) o, si la tarjeta ya fue tokenizada previamente, indicando su uuid en el campo source_uuid únicamente.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

method
required
string
Enum: "MAIL" "PHONE"

Origen de los datos de tarjeta (llamada telefónica o por correo).

card_holder
string

Titular de la tarjeta.

card_pan
string

Número de la tarjeta.

card_expiry_month
string

Mes de expiración de la tarjeta.

card_expiry_year
string

Año de expiración de la tarjeta.

card_cvv
string

Número de verificación que aparece normalmente en el reverso de la tarjeta.

card_additional
string

Descripción que se asociará a la tarjeta.

source_uuid
string

Identificador único del medio de pago empleado para realizar el pago.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55",
  • "method": "MAIL",
  • "card_holder": "John Doe",
  • "card_pan": "4111111111111111",
  • "card_expiry_month": "12",
  • "card_expiry_year": "19",
  • "card_cvv": "123",
  • "card_additional": "card12345"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T15:39:48+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "32e999af0254635606ef70d1cb7b8148c0182c1b75c85a73af27cb676563882d"
}

Por redirección

Mediante este método se le presenta al usuario una carta de pago en la que deberá introducir sus datos de tarjeta. Para ello se utiliza el token obtenido al generar la orden de cobro.

path Parameters
token
required
string
Example: ebc9b5ffa2efcf74197734a071192817e6f2a3fc15f49c4b1bdb6edc46b16e3ab4109498bff8e6ba00fb6d2bd1838afbea67095c4caaa2f46e4acf4d5851884c

El token de la orden.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
text/html

Devolución

Este endpoint se utiliza para devolver un importe a la tarjeta con la que se hizo el pago. Si no se envía el campo amount, la devolución será total. Si se envía este campo, la devolución será del importe enviado (siempre y cuando sea válido).

Cuando la devolución se haga a través de un marketplace. Se debe incluir el campo extra_data, indicando dentro marketplace_refundsy los datos pertinentes a cada comercio y el importe devuelto por cada uno.

En el campo amount, del comercio que efectúa la devolución, será igual al amount indicado fuera del extra_data y en el net_amount se indicará el importe que devolverá cada una de las partes involucradas en la devolución.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

amount
number [ 0 .. 2147483647 ] Nullable

Cantidad a devolver, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

object Nullable

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55",
  • "amount": 100,
  • "extra_data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T15:53:55+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "63d795ea1cf9c77d7d9a4c52e6c174b97ffed8292d163fe2a92c268c6fd3f3b1"
}

Tokenizado por 3DS

Este método de pago es similar al pago por webservice, con la diferencia que en este caso al usuario se le mostrará la pantalla de 3DS antes de finalizarlo.

path Parameters
token
required
string
Example: ebc9b5ffa2efcf74197734a071192817e6f2a3fc15f49c4b1bdb6edc46b16e3ab4109498bff8e6ba00fb6d2bd1838afbea67095c4caaa2f46e4acf4d5851884c

El token de la orden.

Responses

Response samples

Content type
text/html

Pago PUSH

Este endpoint permite lanzar pagos que soportan el envío de notificaciones a teléfonos móviles.

Actualmente esta modalidad de pago solo esta disponible en REDSYS para realizar pagos Bizum.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T15:39:48+0100",
  • "order": {
    },
  • "client": {
    },
  • "extra_data": {
    },
  • "validation_hash": "32e999af0254635606ef70d1cb7b8148c0182c1b75c85a73af27cb676563882d"
}

Pago mediante wallet

Si se quiere integrar directamente Google Pay o Apple Pay, se puede proceder al pago indicando la orden a pagar y el Payload devuelto por cualquiera de estos wallet. Este flujo es necesario en pagos a través de APP ya que no es posible mostrar el botón de Google Pay o Apple Pay en un webview desde un dispositivo móvil.

Si el wallet es Google Pay, es posible que sea necesario finalizar el cobro mediante 3DS. En este caso, la respuesta devuelta contendrá la URL a la que debe redirigirse al usuario para autenticarse y poder finalizar el cobro. Si el wallet es Apple Pay, la orden se considerará pagada como 3DS porque Apple Pay se considera un método de pago seguro.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

wallet
required
string
Enum: "GOOGLEPAY" "APPLEPAY"

Tipo de wallet utilizado.

payload
required
string

Payload devuelto por el wallet (Google Pay o Apple Pay).

customer_ip
string

IP del usuario.

flow
string Nullable
Default: "APP"
Enum: "APP" "WEB"

Indica si la obtención de la tarjeta se realizó a través del navegador o una app móvil.

Responses

Request samples

Content type
application/json
Example
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1F405EA3-9798-42A6-9E87-BD347EF67F55",
  • "wallet": "GOOGLEPAY",
  • "payload": {
    },
  • "customer_ip": "62.43.214.55",
  • "flow": "WEB"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T13:51:27+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "88e0b4e4ca902beb6df70693a0a94164be0485bab865dc168e3a1bf6bf5a71f7"
}

Abonos

Abono

Transfiere fondos al source_uuid indicado del usuario. Para enviar dinero a una tarjeta, es necesario que ésta haya realizado alguna operación de cobro previa en el terminal. Si no se indica source_uuid, se seleccionará la última tarjeta que haya realizado un pago exitoso y esté asociada al customer_ext_id indicado al generar la orden.

También existen otras formas de transferir fondos a un usuario. Algunos servicios soportan métodos de pago alternativos como Bizum o transferencias bancarias. Si se utiliza un servicio con más de una forma de transferir fondos, es obligatorio indicar el campo apm para especificar cuál de ellos se utilizará. Podrá encontrar más información al respecto de estos métodos de pago en la Documentación. No todos los APM soportan abonos.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

order_uuid
required
string

Identificador único de la orden.

source_uuid
string

Identificador único del medio de pago empleado para realizar el pago.

customer_ip
string

IP del usuario.

apm
string Nullable
Enum: "BIZUM" "IDEAL" "SOFORT" "KLARNA" "VIACASH" "COFIDIS" "PIX" "CRYPTO" "GIROPAY" "TRANSFER"

Método de pago alternativo.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "order_uuid": "1f405ea3-9798-42a6-9e87-bd347ef67f55",
  • "source_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "customer_ip": "127.0.0.1",
  • "apm": "BIZUM"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-28T16:08:07+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "81c46c70ab2ec6f766b0e118cd7fe8e39641aee9bee8c7a67dcf87b9a4c3ddc0"
}

Órdenes

Leer orden

Este método devuelve la información asociada a una orden, pudiendo ver el estado en el que se encuentra y sus transacciones. Si el pago de la transacción se realizo mediante un dispositivo físico, también aparecerá un campo "pos" dentro de cada transacción con los datos del mismo.

path Parameters
order_uuid
required
string
Example: 1f405ea3-9798-42a6-9e87-bd347ef67f55

Identificador único de la orden.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-17T11:46:00+0100",
  • "order": {
    },
  • "client": {
    },
  • "validation_hash": "69fa69f2e333e5199357a33bb06d048495c86ca38ba822e4aa4c38405f6648c0"
}

Obtener listado de transacciones

Este método devuelve el listado de transacciones del cliente y la de sus hijos, en base a unos filtros enviados en la query.

query Parameters
start
string
Example: start=202012312359

Fecha inicial en formato YYYYMMDDHHmm.

end
string
Example: end=202112312359

Fecha final en formato YYYYMMDDHHmm.

terminal
number
Example: terminal=65432781

Identificador del terminal (FUC). Solo Redsys.

limit
number
Example: limit=10

Límite de resultados de la consulta. Por defecto y como máximo 10000.

offset
number
Example: offset=20

Número de resultados a saltar. Puede ser usado para paginar los resultados.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "count": 2,
  • "current_time": "2017-01-01T00:00:00+0200",
  • "message": "OK",
  • "transactions": [
    ]
}

Clientes

Crear

Mediante este método se crea un nuevo cliente (customer) en el sistema, con el fin de asignarle posteriormente una tarjeta tokenizada.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "customer_ext_id": "customer15487"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "Customer": {
    }
}

Crear cuenta

Mediante este método se crean los datos asociados a una cuenta bancaria de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

account_type
required
string (AccountType)
Enum: "ACCOUNT_NUMBER" "BUSINESS" "ACCOUNT_CLABE" "CARD_NUMBER" "INTEREST_CHECKING" "MONEY_MARKET" "MOBILE_PHONE_NUMBER" "NOT_USED_FOR_THIS_BANK" "PERSONAL" "REGULAR_CHECKING" "SAVING_ACCOUNT"

Tipo de cuenta bancaria.

account_number
required
string

Número de cuenta bancaria.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "account_number": "100169168",
  • "account_type": "ACCOUNT_NUMBER",
  • "external_id": "12345678A"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T15:57:46+0100",
  • "customer": {
    },
  • "customer_account": {
    }
}

Actualizar cuenta

Mediante este método se actualizan los datos asociados a una cuenta bancaria de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

uuid
required
string

Identificador de la cuenta del usuario.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

account_type
required
string (AccountType)
Enum: "ACCOUNT_NUMBER" "BUSINESS" "ACCOUNT_CLABE" "CARD_NUMBER" "INTEREST_CHECKING" "MONEY_MARKET" "MOBILE_PHONE_NUMBER" "NOT_USED_FOR_THIS_BANK" "PERSONAL" "REGULAR_CHECKING" "SAVING_ACCOUNT"

Tipo de cuenta bancaria.

account_number
required
string

Número de cuenta bancaria.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "uuid": "9B5DDCC2-24A9-4157-A56D-193EB9EF3966",
  • "external_id": "12345678A",
  • "account_type": "ACCOUNT_NUMBER",
  • "account_number": "100169168"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:00:36+0100",
  • "customer": {
    },
  • "customer_account": {
    }
}

Eliminar cuenta

Mediante este método se eliminan los datos asociados a una cuenta bancaria de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

uuid
required
string

Identificador de la cuenta del usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "uuid": "9B5DDCC2-24A9-4157-A56D-193EB9EF3966"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:40:23+0100",
  • "customer_account": {
    }
}

Obtener cuenta

Mediante este método se obtienen los datos asociados a una cuenta bancaria de un usuario en el sistema.

path Parameters
uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la cuenta del usuario.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
uuid
required
string

Identificador de la cuenta del usuario.

Responses

Request samples

Content type
application/json
{
  • "uuid": "9B5DDCC2-24A9-4157-A56D-193EB9EF3966"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:24:21+0100",
  • "customer_account": {
    }
}

Crear dirección

Mediante este método se crean los datos asociados a una dirección de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
address1
required
string

Línea 1 de Dirección (max. 50 carácteres).

address2
string Nullable

Línea 2 de Dirección (max. 50 carácteres).

address3
string Nullable

Línea 3 de Dirección (max. 50 carácteres).

city
required
string

Ciudad.

country
required
string

Código alfanumérico de tres letras ISO 3166 del país.

default
required
boolean

Configurar como dirección por defecto. Si el usuario tiene una dirección por defecto, se utilizará ésta siempre que no se indique una diferente.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

state_code
required
string

Estado o provincia.

type
required
string (AddressType)
Enum: "OTHER" "BILLING" "SHIPPING"

Tipo de dirección.

zip_code
required
string

Código postal.

Responses

Request samples

Content type
application/json
{
  • "address1": "Ronda",
  • "address2": "Magdalena",
  • "address3": "número 20",
  • "city": "Castellón",
  • "country": "ESP",
  • "default": false,
  • "external_id": "12345678A",
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "state_code": "Castellón",
  • "zip_code": "12006"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:47:48+0100",
  • "customer": {
    },
  • "customer_address": {
    }
}

Actualizar dirección

Mediante este método se actualizan los datos asociados a un UUID de dirección. No se podrá actualizar el tipo de dirección.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
uuid
required
string

Identificador de la dirección del usuario.

address1
required
string

Línea 1 de Dirección (max. 50 carácteres).

address2
string Nullable

Línea 2 de Dirección (max. 50 carácteres).

address3
string Nullable

Línea 3 de Dirección (max. 50 carácteres).

city
required
string

Ciudad.

country
required
string

Código alfanumérico de tres letras ISO 3166 del país.

default
required
boolean

Configurar como dirección por defecto. Si el usuario tiene una dirección por defecto, se utilizará ésta siempre que no se indique una diferente.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

state_code
required
string

Estado o provincia.

type
required
string (AddressType)
Enum: "OTHER" "BILLING" "SHIPPING"

Tipo de dirección.

zip_code
required
string

Código postal.

Responses

Request samples

Content type
application/json
{
  • "uuid": "9B5DDCC2-24A9-4157-A56D-193EB9EF3966",
  • "address1": "Ronda",
  • "address2": "Magdalena",
  • "address3": "número 20",
  • "city": "Castellón",
  • "country": "ESP",
  • "default": false,
  • "external_id": "12345678A",
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "state_code": "Castellón",
  • "zip_code": "12006"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:54:54+0100",
  • "customer": {
    },
  • "customer_address": {
    }
}

Eliminar dirección

Mediante este método se eliminan los datos asociados a una dirección de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

uuid
required
string

Identificador de la dirección del usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "uuid": "B7B20B82-0112-464F-BE0F-2905BA84CDED"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T17:04:32+0100",
  • "customer_address": {
    }
}

Obtener dirección

Devuelve la dirección de un usuario, dado su UUID.

path Parameters
uuid
required
string
Example: 1f405ea3-9798-42a6-9e87-bd347ef67f55

Address UUID

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T16:58:57+0100",
  • "customer_address": {
    }
}

Crear perfil

Mediante este método se crea un nuevo perfil asociado al usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

first_name
required
string

Nombre del usuario.

last_name
required
string

Apellidos del usuario.

cardholder_name
string

Titular de la tarjeta.

document_identification_issuer_type
string (DocumentIdentificationIssuer)
Enum: "STATE_GOVERNMENT" "FEDERAL_GOVERNMENT" "MONEY_TRANSMITTER" "PROFESSIONAL_ASSOCIATION"

Proveedor del documento de identificación.

document_identification_type
string (DocumentIdentificationType)
Enum: "ALIEN_REGISTRATION_CARD" "ELECTOR_CREDENTIAL" "FISCAL_IDENTIFICATION_CODE" "ORIGIN_COUNTRY_IDENTIFICATION_CODE" "FOREIGN_IDENTIFICATION_DOCUMENT" "NATIONAL_IDENTITY_DOCUMENT" "OTHER_PHYSICAL_PERSON_DOCUMENTS" "DRIVER_LICENSE" "CONSULAR_REGISTRATION" "UNDER_AGE" "RESIDENCE_CARD" "TAX_IDENTIFICATION_NUMBER" "NON_DRIVER_LICENSE_PHOTO_ID" "VALID_PASSPORT" "DIPLOMAT_IDENTITY_CARD" "US_GOVERNMENT_ISSUER_ID" "UNIQUE_ID_ISSUED_BY_MT"

Tipo de documento de identificación del usuario.

document_identification_number
string Nullable

Número de identificación.

email
string Nullable

Correo electrónico del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

birthdate
string Nullable

Fecha de nacimiento del usuario.

source_of_funds
string Nullable

Origen de los ingresos del usuario.

occupation
string Nullable

Puesto de trabajo del usuario.

social_security_number
string Nullable

Número de seguridad social del usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "external_id": "1024",
  • "first_name": "Paco",
  • "last_name": "García",
  • "cardholder_name": "Paco Garcia",
  • "document_identification_issuer_type": "STATE_GOVERNMENT",
  • "document_identification_type": "ALIEN_REGISTRATION_CARD",
  • "document_identification_number": "12345678A",
  • "email": "aaronarriero_.@gmail.co.com",
  • "phone": {
    },
  • "work_phone": {
    },
  • "home_phone": {
    },
  • "mobile_phone": {
    },
  • "occupation": "ball juggler",
  • "social_security_number": "1212121212",
  • "birthdate": "1986-03-06",
  • "source_of_funds": "Bank"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T14:06:39+0100",
  • "customer": {
    },
  • "customer_profile": {
    }
}

Actualizar perfil

Mediante este método se actualiza un perfil existente de un usuario en el sistema.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

first_name
required
string

Nombre del usuario.

last_name
required
string

Apellidos del usuario.

cardholder_name
string

Titular de la tarjeta.

document_identification_issuer_type
string (DocumentIdentificationIssuer)
Enum: "STATE_GOVERNMENT" "FEDERAL_GOVERNMENT" "MONEY_TRANSMITTER" "PROFESSIONAL_ASSOCIATION"

Proveedor del documento de identificación.

document_identification_type
string (DocumentIdentificationType)
Enum: "ALIEN_REGISTRATION_CARD" "ELECTOR_CREDENTIAL" "FISCAL_IDENTIFICATION_CODE" "ORIGIN_COUNTRY_IDENTIFICATION_CODE" "FOREIGN_IDENTIFICATION_DOCUMENT" "NATIONAL_IDENTITY_DOCUMENT" "OTHER_PHYSICAL_PERSON_DOCUMENTS" "DRIVER_LICENSE" "CONSULAR_REGISTRATION" "UNDER_AGE" "RESIDENCE_CARD" "TAX_IDENTIFICATION_NUMBER" "NON_DRIVER_LICENSE_PHOTO_ID" "VALID_PASSPORT" "DIPLOMAT_IDENTITY_CARD" "US_GOVERNMENT_ISSUER_ID" "UNIQUE_ID_ISSUED_BY_MT"

Tipo de documento de identificación del usuario.

document_identification_number
string Nullable

Número de identificación.

email
string Nullable

Correo electrónico del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

required
object (Phone)

Número de teléfono del usuario.

birthdate
string Nullable

Fecha de nacimiento del usuario.

source_of_funds
string Nullable

Origen de los ingresos del usuario.

occupation
string Nullable

Puesto de trabajo del usuario.

social_security_number
string Nullable

Número de seguridad social del usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "external_id": "1024",
  • "first_name": "Paco",
  • "last_name": "García",
  • "cardholder_name": "Paco Garcia",
  • "document_identification_issuer_type": "STATE_GOVERNMENT",
  • "document_identification_type": "ALIEN_REGISTRATION_CARD",
  • "document_identification_number": "12345678A",
  • "email": "aaronarriero_.@gmail.co.com",
  • "phone": {
    },
  • "work_phone": {
    },
  • "home_phone": {
    },
  • "mobile_phone": {
    },
  • "occupation": "ball juggler",
  • "social_security_number": "1212121212",
  • "birthdate": "1986-03-06",
  • "source_of_funds": "Bank"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T15:04:39+0100",
  • "customer": {
    },
  • "customer_profile": {
    }
}

Obtener perfil

Mediante este método se obtiene un perfil de un usuario.

path Parameters
external_id
required
string
Example: 12345678A

ID externo otorgado por el comercio para identificar de forma única a un usuario.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

Responses

Request samples

Content type
application/json
{
  • "external_id": "12345678A"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-11-19T15:09:31+0100",
  • "customer_profile": {
    }
}

Tarjetas

Guardar varias tarjetas de crédito/débito

Mediante este endpoint se pueden almacenar varias tarjetas simultáneamente, las cuales podrán ser utilizadas posteriormente para realizar pagos mediante Webservice.

Si se indica el campo validate a true, la tarjeta será validada contra el servicio indicado en el campo service para comprobar si existe y tiene fondos en el momento de la validación. Algunos servicios requieren que el campo card_cvv sea indicado.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

required
Array of objects

Lista de tarjetas a tokenizar.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "cards": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-05-19T12:18:49+0200",
  • "cards": [
    ]
}

Guardar tarjeta crédito/débito

Endpoint utilizado para almacenar una tarjeta de crédito, que se podrá utilizar para realizar un pago por WebService. La tarjeta será asociada al usuario indicado en el parámetro customer_ext_id.

Los campos validate y service sólo deberán enviarse en caso de querer validar la tarjeta contra el servicio, para comprobar si existe o si tiene fondos en el momento de la validación.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

card_holder
required
string

Titular de la tarjeta.

card_pan
required
string

Número de la tarjeta.

card_expiry_month
required
string

Mes de expiración de la tarjeta.

card_expiry_year
required
string

Año de expiración de la tarjeta.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

url_post
string

URL que recibirá una notificación HTTP indicando el estado final del pago.

validate
boolean Nullable
Default: false

Sólo necesario si se quiere validar la tarjeta. Si se envía, el campo service es obligatorio, y el campo card_cvv puede enviarse para validar también el CVV.

service
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

card_cvv
string

Número de verificación que aparece normalmente en el reverso de la tarjeta.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "card_holder": "John Doe",
  • "card_pan": "4111111111111111",
  • "card_expiry_month": "12",
  • "card_expiry_year": "19",
  • "customer_ext_id": "user42",
  • "additional": "card12345",
  • "validate": true,
  • "service": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045",
  • "card_cvv": "123"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "Customer": {
    },
  • "Source": {
    }
}

Eliminar tarjeta

Mediante este endpoint se puede eliminar una tarjeta almacenada.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

card_uuid
required
string

Identificador de la tarjeta.

customer_external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "card_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "customer_external_id": "user1234"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "message": "OK"
}

Revalidar una tarjeta ya tokenizada

Mediante este endpoint se puede validar una tarjeta previamente tokenizada para comprobar si tiene fondos en el momento de la validación. Algunos servicios requieren que el campo card_cvv sea indicado.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

source_uuid
required
string

Identificador único del medio de pago empleado para realizar el pago.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

service
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

card_cvv
string

Número de verificación que aparece normalmente en el reverso de la tarjeta.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "source_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "customer_ext_id": "12345678A",
  • "service": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045",
  • "card_cvv": "123"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "Customer": {
    },
  • "Source": {
    }
}

Establecer/modificar la descripción

Mediante este endpoint se puede asociar una descripción a las tarjetas de crédito.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

source_uuid
required
string

Identificador único del medio de pago empleado para realizar el pago.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "source_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "additional": "Tarjeta principal"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100",
  • "Customer": {
    },
  • "Source": {
    }
}

Obtener las tarjetas de un usuario

Mediante este método se obtiene el listado de tarjetas almacenadas en el sistema para un cliente dado. El customer_ext_id debe coincidir con el que se utilizó al guardar la tarjeta en el sistema o al crear la orden de pago para cliente.

path Parameters
customer_ext_id
required
string
Example: 123fd2

ID externo otorgado por el comercio para identificar de forma única a un usuario.

query Parameters
status
string
Example: status=VALIDATED

Especifica qué tarjetas se obtendrán. Admite dos posibles valores:

  • VALIDATED - Sólo devolverá aquellas tarjetas que se validaron correctamente cuando se guardaron o que se han podido utilizar en un pago correcto. Este es el valor por defecto.

  • ALL - Devolverá todas las tarjetas, tanto las validadas por el banco como las no validadas.

unique
string
Example: unique=false

Cuando se realiza una operación en Paylands, se asocia a una tarjeta del usuario. Si se utiliza esta tarjeta en otra operación, se crea otra entrada en el sistema. A la hora de obtener las tarjetas, este parámetro indica si se necesita obtenerlas todas con repetición (si se han usado en más de un pago) o sin repetición. Obtenerlas repetidas es útil para saber cuantas veces se ha usado una tarjeta. Sin embargo, si lo que se necesita es mostrarlas en un desplegable al usuario, se recomienda obtenerlas sin repetición. Admite dos posibles valores booleanos:

  • true - Sólo devolverá una ocurrencia por tarjeta.

  • false - Devolverá una tarjeta por pago. Si una tarjeta se ha usado en N pagos, aparecerá N veces en el json de respuesta. Este es el valor por defecto.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "cards": [
    ]
}

Ver tarjeta de crédito/débito

Mediante este endpoint se pueden obtener los datos de una tarjeta dado su UUID. La respuesta sigue la misma estructura que en el endpoint de almacenar tarjeta.

path Parameters
uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador único de la tarjeta.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "Customer": {
    },
  • "Source": {
    }
}

Cuentas bancarias

Nueva cuenta bancaria

Endpoint utilizado para almacenar una cuenta bancaria. La cuenta será asociada al usuario indicado en el parámetro customer_ext_id.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

account_holder
required
string

Titular de la cuenta bancaria.

iban
required
string

IBAN de la cuenta bancaria.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "account_holder": "John Doe",
  • "iban": "ES9030350000070000000202",
  • "customer_ext_id": "user42",
  • "additional": "bank12345"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2023-04-20T11:29:05+0200",
  • "Customer": {
    },
  • "Source": {
    }
}

Eliminar cuenta bancaria

Mediante este endpoint se puede eliminar una cuenta bancaria.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

source_uuid
required
string

Identificador único del medio de pago empleado para realizar el pago.

customer_ext_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "source_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
  • "customer_ext_id": "user1234"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "message": "OK"
}

Obtener las cuentas bancarias de un usuario

Mediante este método se obtiene el listado de cuentas bancarias almacenadas en el sistema para un cliente dado.

El customer_ext_id debe coincidir con el que se utilizó al guardar la cuenta bancaria en el sistema o al crear la orden de pago para cliente.

path Parameters
customer_ext_id
required
string
Example: 123fd2

ID externo otorgado por el comercio para identificar de forma única a un usuario.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2023-04-20T12:49:29+0200",
  • "banks": [
    ]
}

Ver cuenta bancaria

Mediante este endpoint se pueden obtener los datos de una cuenta bancaria dado su UUID.

path Parameters
uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador único de la cuenta bancaria.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2023-04-20T15:33:24+0200",
  • "bank": {
    }
}

Actualizar external ID

Actualizar external ID tarjetas, tarjetas dinámicas y cuentas bancarias.

Mediante este método se podrá modificar el dueño de una tarjeta ya almacenada en Paylands. Basta con indicar el uuid de la tarjeta, tarjeta dinámicas o cuenta bancaria que desea actualizar en la url. Tras esto indicar en el cuerpo de la petición el external_id actual (old_external_id) y el nuevo (new_external_id).

path Parameters
source_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la forma de pago.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

old_external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

new_external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

Responses

Request samples

Content type
application/json
{
  • "signature": "341f7de8e6fc49da8d8736473af6b03a",
  • "old_external_id": "1024",
  • "new_external_id": "102455"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "message": "OK"
}

Campañas MoTo

Envío de enlaces de pago (CSV)

Las campañas MoTo pueden crearse de dos formas: a través de la sección Campañas MoTo en el panel de Paylands o mediante una petición a la API de Paylands.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
description
required
string

Nombre interno identificativo de la campaña.

expires_at
required
string

Fecha a partir de la cual caducan los pagos de la campaña. Los pagos caducan a las 00:00:00 del día especificado.

file
required
string

Fichero CSV codificado en base64 y encabezado por el texto 'data:text/csv;base64,'

filename
string Nullable

Nombre del fichero .csv.

service_uuid
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

subject
required
string Nullable

Asunto de la campaña, que será enviado si se indica email como método de envío. En el caso de SMS se indicará el nombre del comercio con un máximo de 11 caracteres.

type
required
string (MoToType)
Enum: "PHONE" "MAIL" "CUSTOM_DELIVERY"

Método de envío de los pagos MoTo.

Responses

Request samples

Content type
application/json
{
  • "description": "Campaña de Navidad 2019",
  • "expires_at": "2017-11-11",
  • "file": "data:text/csv;base64,QU1PVU5ULE9QRVJBVElWRSxERVNUSU5BVElPTixDVVNUT01FUl9FWFRfSUQsQURESVRJT05BTCxTRUNVUkUsVVJMX1BPU1QsVVJMX09LLFVSTF9LTyxDQVJEX1RFTVBMQVRFLE1PVE9fVEVNUExBVEUsRENDX1RFTVBMQVRFCjEsREVGRVJSRUQsc3VjY2Vzc0BzaW11bGF0b3IuYW1hem9uc2VzLmNvbSxleHRlcm5hbElELGFkZGl0aW9uYWwsRkFMU0UsaHR0cDovL3VybC5wb3N0LGh0dHA6Ly91cmwub2ssaHR0cDovL3VybC5rbyxDRDVGMzU0MC1CMkNCLTRDNjctQUU2Qi1GNzZFRDkzREU2QzEsRUVCRjEwMjItNkRCMi00NURCLTgxN0QtQTg3QjA5QUU4NDFCLDQwMTExRkU4LTlCMzItNDNFMy1BNEFFLTk3QzdCRTZEMTlDNQ==",
  • "filename": "test.csv",
  • "service_uuid": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045",
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "subject": "Navidad 2019",
  • "type": "PHONE"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2019-05-30T12:52:54+0200",
  • "detail": {
    },
  • "message": "OK",
  • "payments": [
    ]
}

Envío de enlaces de pago (JSON)

Para generar un envío de enlaces de pago mediante JSON será necesario enviar los campos que se detallan a continuación.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
description
required
string

Nombre interno identificativo del envío.

expires_at
required
string

Fecha a partir de la cual caducan los pagos de la campaña. Los pagos caducan a las 00:00:00 del día especificado.

service_uuid
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

subject
required
string Nullable

Asunto de la campaña, que será enviado si se indica email como método de envío. En el caso de SMS se indicará el nombre del comercio con un máximo de 11 caracteres.

type
required
string (MoToType)
Enum: "PHONE" "MAIL" "CUSTOM_DELIVERY"

Método de envío de los pagos MoTo.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "description": "Campaña de Navidad 2019",
  • "expires_at": "2017-11-11",
  • "service_uuid": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045",
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "subject": "Navidad 2019",
  • "type": "PHONE",
  • "payments": {
    }
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2019-05-30T12:52:54+0200",
  • "detail": {
    },
  • "message": "OK",
  • "payments": [
    ]
}

Descargar certificado de recepción

Se puede descargar el certificado de recepción de un pago MoTo a través de su uuid. Disponible para campañas MoTo mediante Email y SMS.

path Parameters
moto_payment_uuid
required
string
Example: C089B1BF-A4FA-4B0F-A5FE-F21C5BFEFC27

Identificador único del pago MoTo.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "certificate": "JVBERi0xLjYKJfbk/N8KMSAwIG9iago8PAovQWNyb0Zvcm0gMiAwIFIKL01ldGFkYXRhIDMg...",
  • "code": 200,
  • "current_time": "2021-02-15T16:55:20+0100",
  • "message": "OK"
}

Consultar ordenes MoTo

Las ordenes MoTo pueden consultarse de dos formas distintas: através del panel de Paylands o usando un endpoint de la API de Paylands.

path Parameters
moto_detail_uuid
required
string
Example: 2FE8B569-6168-428D-9A3A-8BC265215A1B

Identificador de la campaña MoTo.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-05-30T12:52:54+0200",
  • "orders": {
    }
}

Operaciones en lote

Mediante este endpoint se puede enviar un CSV al servidor conteniendo varias operaciones que serán ejecutadas en un proceso batch. Este CSV debe contener una línea de cabecera con el nombre de los campos. La segunda fila y siguientes contendrán toda la información de las diferentes operaciones. Los campos dentro de cada fila deben estar separados por una coma (,).

Fichero de pagos

Encola un fichero de pagos en batch.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
data
required
string

Fichero CSV codificado en base64.

execute_at
string Nullable

Fecha a partir de la cual se procesará el fichero. Si no se especifica esta fecha, el fichero se encolará para su procesado en el momento del envío.

filename
required
string

Nombre del fichero bajo el que se agruparán los pagos enviados.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "data": "QU1PVU5ULENBUkQsQ1VTVE9NRVJfRVhURVJOQUxfSUQsU0VSVklDRSxBRERJVElPTkFMLFVSTF9QT1NUDQoxMjAzNSxFNzZBNTdGRi00REJDLTRBM0QtQjZFMy0wNTIwRThCMTNFM0YsMzA4LDExNEFCNDI0LTAyM0ItNEUxMy",
  • "execute_at": "2017-11-11 11:11:11",
  • "filename": "test.csv",
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2017-10-26T17:28:06+0200"
}

Fichero de devoluciones

Encola un fichero de devoluciones en batch.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
data
required
string

Fichero CSV codificado en base64

execute_at
string Nullable

Fecha a partir de la cual se procesará el fichero. Si no se especifica esta fecha, el fichero se encolará para su procesado en el momento del envío

filename
required
string

Nombre del fichero bajo el que se agruparán las devoluciones enviadas.

signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "data": "T1JERVJfVVVJRCxBTU9VTlQKMjY3Njk3NjMtQTJDOS00QUI4LTgwRDQtOTVERDgyNEUzNzVBLDEKMjY3Njk3NjMtQTJDOS00QUI4LTgwRDQtOTVERDgyNEUzNzVBLDIKMjY3Njk3NjMtQTJDOS00QUI4LTgwRDQtOTVERDgyNEUzNzVBLDMyMjIyCg==",
  • "execute_at": "2017-11-11 11:11:11",
  • "filename": "test.csv",
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-10-26T17:28:06+0200",
  • "errors": [
    ],
  • "message": "OK"
}

Subscripciones

Paylands ofrece la posibilidad de realizar pagos recurrentes mediante suscripciones. Para ello es necesario registrar el producto que se está ofreciendo - por ejemplo, el acceso a un servicio de streaming. Hecho esto pueden registrarse uno o más planes para poder acceder a este producto - por ejemplo, una cuota de 10€/mes y otra de 100€/año.

Para registrar las subscripciones sugerimos elaborar una carta de pago personalizada donde el cliente pueda seleccionar el plan que desee y la tarjeta que será cobrada. Una vez se cumpla el plazo establecido, el cliente recibirá un cargo en su tarjeta y el comercio recibirá una notificación con la información del cargo efectuado y si éste ha sido exitoso o no. Todas estas operaciones se realizarán a través de la API de Paylands.

Los planes son flexibles, pudiéndose cobrar diariamente, semanalmente, mensualmente o anualmente. También es posible que el cobro sea cada varios días, semanas o meses. La primera cuota puede retrasarse varios días o semanas para que los clientes puedan cancelar su suscripción antes de que se realice el primer cobro. Una vez un usuario se ha registrado puede conocerse el día en el cual se realizará el próximo cobro, y el estado de su suscripción - pendiente de pago, pagada o cancelada.

Crear compañía

El primer paso para usar las suscripciones en Paylands es registrarse, creando un perfil en suscripciones donde se relacionarán todos los productos, planes y suscripciones. Basta con hacer una llamada a este endpoint para empezar a usar el servicio.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T11:59:41+0100",
  • "company": {
    }
}

Crear producto

Un producto identifica al servicio que se quiere ofrecer, y puede tener uno o más planes con cuotas diferentes. Los cobros sobre productos marcados como sandbox no se realizan con dinero real.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

name
required
string

Nombre del producto.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un producto.

notification_url
string

URL que recibirá una notificación HTTP cuando el pago cambie de estado.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T15:29:10+0100",
  • "product": {}
}

Listar productos

Lista todos los productos creados hasta la fecha.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T15:29:12+0100",
  • "products": []
}

Obtener un producto

Obtener un producto por su ID externo.

path Parameters
product_external_id
required
string
Example: product

ID único externo.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2020-03-05T16:46:51+0100",
  • "product": {}
}

Eliminar producto

Elimina un producto, dado su ID externo. Al eliminar un producto, las subscripciones asociadas al producto no serán canceladas.

path Parameters
product_external_id
required
string
Example: product

ID externo único del producto.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T15:28:25+0100",
  • "deleted": 1
}

Obtener un pago

Obtener un pago por su ID.

path Parameters
payment_id
required
string
Example: 5e6116949d3a0c6b2e56826c

ID del pago de la subscripción.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2020-03-05T16:13:31+0100",
  • "payment": {
    }
}

Listar pagos

Listar todos los pagos creados.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2020-03-05T16:23:23+0100",
  • "payments": [
    ]
}

Crear plan

Un plan determina el precio y la frecuencia con la que se cobrará la suscripción a un producto, entre otras características. Un plan se asocia a un sólo producto.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

name
required
string

Nombre del plan.

external_id
required
string

ID externo otorgado por el comercio para identificar de forma única a un plan.

product
required
string

ID externo otorgado por el comercio para identificar de forma única a un plan.

amount
required
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

interval
required
number

Intervalo en la unidad indicada en el campo interval_type que determina cada cuánto tiempo debe cobrarse la subscripción.

interval_type
required
string

Determina cada cuánto tiempo debe cobrarse la subscripción. Los valores permitidos son "DAILY", "WEEKLY", "MONTHLY", "ANNUAL"

trial_available
boolean

Por defecto, false. Indica si hay periodo de prueba. Hasta que éste no termine no se realizará el primer cobro.

interval_offset
number

Intervalo en la unidad indicada en el campo interval_offset_type que determina la unidad de tiempo que dura el periodo de prueba de la subscripción.

interval_offset_type
string

Determina cuánto dura el periodo de prueba. Los valores permitidos son "DAILY", "WEEKLY", "MONTHLY", "ANNUAL"

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "name": "Other plan",
  • "external_id": "other_plan",
  • "product": "other_product",
  • "amount": 100,
  • "interval": 1,
  • "interval_type": "MONTHLY",
  • "trial_available": false,
  • "interval_offset": null,
  • "interval_offset_type": "WEEKLY"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2019-12-04T16:30:29+0100",
  • "message": "OK",
  • "plan": {
    }
}

Listar planes

Lista todos los planes creados hasta la fecha.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T16:55:28+0100",
  • "plans": [
    ]
}

Obtener un plan

Obtener un plan por su ID externo.

path Parameters
plan_external_id
required
string
Example: plan

ID externo único del plan.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2020-03-05T16:37:02+0100",
  • "plan": {
    }
}

Eliminar plan

Elimina un plan, dado su ID externo. Al eliminar un plan, las subscripciones asociadas al plan no serán canceladas.

path Parameters
plan_external_id
required
string
Example: plan

ID externo único del plan.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T16:30:29+0100",
  • "deleted": 1
}

Suscribir a un cliente

Suscribe a un cliente a un plan, dado el ID externo del plan y el cliente, entre otros. Si el parámetro trial_available del plan es false, se realiza un cobro inmediatamente tras suscribir al cliente.

Si alguno de los parámetros (UUID de servicio o tarjeta, por ejemplo) es incorrecto la subscripción se registrará pero el pago no podrá realizarse. En este caso el status será FAILED_NOTIFICATION. Un ejemplo de la notificación enviada al notification_url del Producto es el siguiente:

{
    "payment_id": "5dfa00a4229c1a127749ae9e",
    "subscription": "5dfa00a4229c1a127749ae9d",
    "plan": "plan_external_id",
    "product": "product_external_id",
    "customer": "customer_external_id",
    "company": "FF255421-F4B7-47E9-9816-949F5F03DE6F",
    "status": "FAILED_NOTIFICATION",
    "payment_date": "2019-12-18T10:34:12.640Z",
    "payment_number": 1,
    "attempt": 1,
    "amount": 1,
    "currency": "978"
}

sub_diag_seq_1

Si todos los parámetros son correctos, el pago se realizará y Paylands enviará la notificación habitual a la post_url indicada en la Subscripción. También se enviará una notificación a la notification_url del Producto. Un ejemplo de esta notificación se detalla en la segunda respuesta de ejemplo a este endpoint.

sub_diag_seq_2

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

plan
required
string

ID externo otorgado por el comercio para identificar de forma única a un plan.

customer
required
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

required
object

Datos adicionales para procesar el pago.

total_payment_number
required
number

Número total de pagos que se realizarán a lo largo de la suscripción.

payment_attempts_limit
required
number

Número máximo de intentos para cobrar una suscripción. Si el cobro de una suscripción falla X veces consecutivas, la suscripción se cancela.

initial_date
string Nullable

Por defecto es la fecha actual. Si se indica permite especificar el momento en el que se realizará el primer pago.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "customer": "customer name",
  • "plan": "plan",
  • "additional_data": {
    },
  • "initial_date": "2019",
  • "payment_attempts_limit": 3,
  • "total_payment_number": 3
}

Response samples

Content type
application/json
{
  • "amount": 1,
  • "attempt": 1,
  • "company": "FF255421-F4B7-47E9-9816-949F5F03DE6F",
  • "currency": "978",
  • "customer": "customer_external_id",
  • "payment_date": "2019-12-18T10:34:12.640Z",
  • "payment_id": "5dfa00a4229c1a127749ae9e",
  • "payment_number": 1,
  • "plan": "plan_external_id",
  • "product": "product_external_id",
  • "status": "PAID",
  • "subscription": "5dfa00a4229c1a127749ae9d"
}

Listar subscripciones

Lista todas las subscripciones creadas hasta la fecha.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-05T08:42:24+0100",
  • "subscriptions": [
    ]
}

Obtener una subscripción

Obtener una subscripción por su ID.

path Parameters
subscription_id
required
string
Example: 5de7b52ac4d347306fd59ec5

ID único de la subscripción.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2020-03-05T16:51:27+0100",
  • "subscription": {
    }
}

Cancelar una subscripción

Cancela una subscripción dado su ID.

path Parameters
subscription_id
required
string
Example: 5de7b52ac4d347306fd59ec5

ID único de la subscripción.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2019-12-04T17:40:46+0100",
  • "deleted": 1
}

POSMS (Dispositivos físicos)

Paylands ofrece la posibilidad de realizar pagos físicos mediante datáfonos inteligentes. Para utilizar este servicio, es necesarío que desde soporte se le registre en la plataforma y se le configuren los dispositivos necesarios con las credenciales del servicio de Credorax que vaya a ser usado en cada uno de ellos. Una vez tenga los datáfonos inteligentes, puede comenzar a procesar pagos a través de ellos.

En el entorno de sandbox, es posible simular el comportamiento en Paylands de los pagos realizados en dispositivos físicos, sin necesidad de disponer de uno. Para ello, es necesario que desde soporte le asignen un dispositivo con el tipo de comunicación SIMULATION. Estos dispositivos los podrá obtener en el listado de dispositivos junto a los demás. Si lanza un pago, o una devolución, contra uno de estos dispositivos, el pago será procesado automáticamente tras 10 segundos, simulando el comportamiento de pasar la tarjeta en el dispositivo físico.

Puede configurar el tipo de respuesta esperada según la cantidad del pago:

  • Cancelado: el pago será procesado como CANCELADO si la cantidad es 100.
  • Rechazado: el pago será procesado como RECHAZADO si la cantidad es 200.
  • Pagado: el pago será procesado como PAGADO si la cantidad es cualquier otra.

Listar dispositivos físicos

Lista los dispositivos físicos asociados a un comercio.

query Parameters
identifier
string
Example: identifier=611629d29a5b401507c11f7e

Identificador del dispositivo físico.

service
string
Example: service=2A207771-A772-48B1-A56F-F72A2B74D768

Identificador único del servicio de pago.

terminal_id
string
Example: terminal_id=PPESNA0001

Identificador de dispositivo del adquirente.

communication_type
string
Example: communication_type=SOCKET

Protocolo mediante el cual se realizará la comunicación con el dispositivo físico.

active
string
Example: active=SOCKET

Indica si el dispositivo está habilitado para su uso.

configured
string
Example: configured=true

Indica si el dispositivo se ha configurado correctamente para la comunicación y el uso.

created_at_from
string
Example: created_at_from=202112312359

Dispositivos físicos creados a partir de la fecha especificada en formato YYYYMMDDHHmm.

created_at_to
string
Example: created_at_to=202112312359

Dispositivos físicos creados hasta la fecha especificada en formato YYYYMMDDHHmm.

updated_at_from
string
Example: updated_at_from=202112312359

Dispositivos físicos actualizados a partir de la fecha especificada en formato YYYYMMDDHHmm.

updated_at_to
string
Example: updated_at_to=202112312359

Dispositivos físicos actualizados hasta la fecha especificada en formato YYYYMMDDHHmm.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-22T12:00:28+0100",
  • "devices": [
    ]
}

Obtener dispositivo

Obtener la información de un dispositivo físico por su ID.

path Parameters
id
required
string
Example: 611629d29a5b401507c11f7e

Identificador único del dispositivo físico.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-22T12:00:28+0100",
  • "device": {
    }
}

Enviar pago

Este endpoint permite enviar una orden con operativa AUTORIZACIÓN al dispositivo elegido.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

device
required
string

Identificador del dispositivo físico.

amount
required
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

description
required
string

Descripción del pago. Para los pagos mediante transferencia bancaria, el concepto que verá el usuario será el indicado en este campo.

customer_ext_id
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

url_post
string

URL que recibirá una notificación HTTP indicando el estado final del pago.

reference
string Nullable

Referencia de la orden. Puede ser utilizado como identificador externo o para evitar pagos duplicados.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "device": "611629d29a5b401507c11f7e",
  • "amount": 100,
  • "description": "Order's description",
  • "customer_ext_id": "12345678A",
  • "additional": "Additional info",
  • "reference": "XXX1234ABC"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-23T16:31:47+0100",
  • "order": {
    },
  • "client": {
    },
  • "device": {
    }
}

Enviar pre-autorización

Este endpoint permite enviar una orden con operativa DEFERRED al dispositivo elegido.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

device
required
string

Identificador del dispositivo físico.

amount
required
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

description
required
string

Descripción del pago. Para los pagos mediante transferencia bancaria, el concepto que verá el usuario será el indicado en este campo.

customer_ext_id
string

ID externo otorgado por el comercio para identificar de forma única a un usuario.

additional
string

Campo de texto libre enviado por el comercio. Puede utilizarse para almacenar cualquier dato.

url_post
string

URL que recibirá una notificación HTTP indicando el estado final del pago.

reference
string Nullable

Referencia de la orden. Puede ser utilizado como identificador externo o para evitar pagos duplicados.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "device": "611629d29a5b401507c11f7e",
  • "amount": 100,
  • "description": "Order's description",
  • "customer_ext_id": "12345678A",
  • "additional": "Additional info",
  • "reference": "XXX1234ABC"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-23T16:31:47+0100",
  • "order": {
    },
  • "client": {
    },
  • "device": {
    }
}

Enviar confirmación

Este endpoint permite enviar una confirmación de una pre-autorización a un dispositivo elegido.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

device
required
string

Identificador del dispositivo físico.

order_uuid
required
string

Identificador único de la orden.

amount
number [ 0 .. 2147483647 ]

Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "device": "611629d29a5b401507c11f7e",
  • "order_uuid": "4DE116C9-0064-4BCA-A5D0-1D69A8E972FD",
  • "amount": 100
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-23T16:34:56+0100",
  • "order": {
    },
  • "client": {
    },
  • "device": {
    }
}

Enviar cancelación

Este endpoint permite enviar una cancelación de una pre-autorización a un dispositivo elegido.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

device
required
string

Identificador del dispositivo físico.

order_uuid
required
string

Identificador único de la orden.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "device": "611629d29a5b401507c11f7e",
  • "order_uuid": "4DE116C9-0064-4BCA-A5D0-1D69A8E972FD"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-23T16:34:56+0100",
  • "order": {
    },
  • "client": {
    },
  • "device": {
    }
}

Enviar devolución

Se puede enviar el importe amount si se desea realizar una devolución parcial. Si éste no se indica se tomará como valor el restante por devolver.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

device
required
string

Identificador del dispositivo físico.

order_uuid
required
string

Identificador único de la orden.

amount
number [ 0 .. 2147483647 ] Nullable

Cantidad a devolver, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "device": "611629d29a5b401507c11f7e",
  • "order_uuid": "4DE116C9-0064-4BCA-A5D0-1D69A8E972FD",
  • "amount": 50
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-11-23T16:34:56+0100",
  • "order": {
    },
  • "client": {
    },
  • "device": {
    }
}

Listas de seguridad

Creación de listas

Endpoint para crear una lista de un tipo determinado. Puede ser blacklist, whitelist o greylist.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

type
required
string
Enum: "WHITELIST" "BLACKLIST" "GREYLIST"

Tipo de lista.

enabled
required
boolean

Indica si esta activado.

description
required
string

Descripción del pago. Para los pagos mediante transferencia bancaria, el concepto que verá el usuario será el indicado en este campo.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "type": "BLACKLIST",
  • "enabled": true,
  • "description": "Black list example"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100",
  • "colorlists": {
    }
}

Obtener todas las listas de un tipo

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100",
  • "colorlists": [
    ]
}

Obtener lista

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100",
  • "colorlists": {
    }
}

Borrar lista

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b"
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100"
}

Habilitar y deshabilitar lista

Con este endpoint podemos habilitar o deshabilitar una lista

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100",
  • "colorlists": {
    }
}

Asociar servicios a la lista.

Este endpoint permite asociar un servicio a una lista.

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

service_uuid
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "service_uuid": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "message": "OK"
}

Desasociar servicios a las listas

Este endpoint permite desasociar un servicio de una lista.

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

service_uuid
required
string

El UUID del servicio de pago empleado para llevar a cabo la operación.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "service_uuid": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "current_time": "2017-01-12T09:12:58+0100",
  • "message": "OK"
}

Crear items asociados a una lista

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

required
Array of objects

Items que se van a añadir a la lista.

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100"
}

Borrar items de una lista

path Parameters
list_uuid
required
string
Example: 1F405EA3-9798-42A6-9E87-BD347EF67F55

Identificador de la lista.

header Parameters
Authorization
required
string
Example: Basic RXN0YUVzVHVBUElLZXlNYW50ZW5sYVNlZ3VyYQ==

Cabecera de autorización a la que debes añadir tu API Key.

Request Body schema: application/json
signature
required
string

Firma que acompaña a la API key. Requerida en todas las peticiones POST/PUT/DELETE.

items
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "signature": "121149a0ba5361191d740fa898784a8b",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "OK",
  • "code": 200,
  • "current_time": "2021-12-29T10:14:14+0100"
}