Documentación de Paylands (1.0.0)
Download OpenAPI specification:Download
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
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
- 200
- 400
- 403
{- "code": 200,
- "message": "OK",
- "current_time": "2019-05-30T12:55:48+0200"
}
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
- 200
{- "code": 200,
- "current_time": "2019-05-30T12:55:48+0200",
- "message": "OK",
- "profiles": [
- "payment",
- "readonly",
- "tokenize",
- "batch_authorization",
- "keyentry"
]
}
Obtener perfiles API key
Este endpoint sirve para obtener todos los perfiles que puede tener una API key.
all
: Acceso totalpayment
: Creación de órdenes, pagos, devoluciones, confirmaciones, cancelaciones, tokenización de tarjetasrefund
: Devolver órdenes.readonly
: Leer órdenes, clientes, tarjetas, etc,card
: Tokenizar, listar, modificar y borrar tarjetastokenize
: Tokenizar tarjetasmoto
: Lanzar campañas MoTobatch_authorization
: Lanzar pagos en lotebatch_refund
: Lanzar devoluciones en lotekeyentry
: 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
- 200
{- "code": 200,
- "current_time": "2019-05-30T12:55:48+0200",
- "message": "OK",
- "profiles": [
- "payment"