Creación del checkout

La creación del checkout se realizará mediante una petición POST al servidor de Aplazame.

Si estás iniciando la integración, te puede interesar consultar cómo establecer el modo de pruebas y también los datos de prueba disponibles para la integración.

Pago a plazos

POST https://api.aplazame.com/checkout
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Content-Type: application/json

{
  "merchant": {...},
  "order": {...},
  "customer": {...},
  "billing": {...},
  "shipping": {...}
}
Parámetro Tipo Requerido Descripción
merchant object si Datos del merchant
order object si Datos del pedido
customer object si Datos del cliente
billing object no Dirección de facturación
shipping object si Información de envío

Pago en 15 días

POST https://api.aplazame.com/checkout
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Content-Type: application/json

{
  "merchant": {...},
  "order": {...},
  "customer": {...},
  "billing": {...},
  "shipping": {...},
  "product": {
        "type": "pay_later"
  }
}
Parámetro Tipo Requerido Descripción
merchant object si Datos del merchant
order object si Datos del pedido
customer object si Datos del cliente
billing object no Dirección de facturación
shipping object si Información de envío
product object no Tipo de producto. Si no se indica el producto, por defecto es Pago a plazos

merchant

{
  "merchant": {
    "notification_url": "https://merchant.com/order/confirm",
    "success_url": "/success",
    "pending_url": "/pending",
    "error_url": "/error",
    "dismiss_url": "/",
    "ko_url": "/ko",
    "close_on_success": false,
    "timeout_checkout": 60,
    "timeout_extra": 2880
  },
  // ...
}
Parámetro Tipo Requerido Descripción
notification_url url si URL a la que se notificará los cambios de estado del pedido y que servirá para completar la confirmación final.
success_url url si URL (relativa a la tienda) a la que se redirigirá al usuario cuando se haya completado el pago.
pending_url url si URL (relativa a la tienda) a la que se redirigirá al usuario cuando el pago quede pendiente de confirmación.
error_url url si URL (relativa a la tienda) a la que se redirigirá al usuario cuando haya ocurrido un error.
dismiss_url url no URL (relativa a la tienda) a la que se redirigirá al usuario cuando éste escoge volver a la tienda (por defecto '/').
ko_url url no URL (relativa a la tienda) a la que se redirigirá al usuario cuando se haya denegado el pago.
close_on_success boolean no Indica si el checkout se redirige automáticamente a success_url en caso de éxito. ( por omisión: false )
timeout_checkout entero no Establece el tiempo máximo, en minutos, del que dispone el usuario para completar el proceso de checkout. (por omisión 60; mín. 1; máx. 120 )
timeout_extra entero no Establece el tiempo adicional, en minutos, del que dispone el usuario para completar la validación de identidad una vez finalizado el proceso de checkout. ( por omisión 2880; mín. 0; máx. 2880 )

order

{
  "id": "28475648233786783165",
  "articles": [
    {
      "id": "89793238462643383279",
      "name": "Reloj en oro blanco de 18 quilates y diamantes",
      "quantity": 2,
      "price": 402000,
      "tax_rate": 2100,
      "discount_rate": 200,
      "description": "Movimiento de cuarzo de alta precisión",
      "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
      "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
    },
    ...
  ],
  "discount": 16000,
  "currency": "EUR",
  "total_amount": 462000
}
Parámetro Tipo Requerido Descripción
id string si ID del pedido.
discount decimal no Importe de descuento en el precio del pedido
discount_rate decimal no Tasa de descuento en el precio del pedido
cart_discount decimal no Importe de descuento en el precio del carrito
cart_discount_rate decimal no Tasa de descuento en el precio del carrito
currency ISO 4217 si Código de la moneda del pedido
tax_rate decimal si Tasa de impuesto en el precio del pedido
total_amount decimal si Cantidad a financiar
articles collection si Artículos en el carrito

tax_rate

Cada articulo del pedido debe tener tax_rate. Alternativamente puedes incluirlo globalmente en order.tax_rate o puedes aplicarlo a cada artículo y envío.

article

{
  "id": "89793238462643383279",
  "name": "Reloj en oro blanco de 18 quilates y diamantes",
  "quantity": 2,
  "price": 402000,
  "tax_rate": 2100,
  "discount_rate": 200,
  "description": "Movimiento de cuarzo de alta precisión",
  "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
  "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
}
Parámetro Tipo Requerido Descripción
id string si ID
name string si Nombre
description string no Descripción
url URL si URL absoluta del artículo
image_url URL si URL absoluta de la imagen del artículo
quantity integer si Cantidad
price decimal si Precio (sin impuestos)
tax_rate decimal no Tasa de impuestos en el precio
discount decimal no Importe de descuento en el precio
discount_rate decimal no Tasa de descuento en el precio

customer

{
  "id": "1618",
  "email": "customer@merchant.com",
  "type": "e",
  "gender": 0,
  "first_name": "John",
  "last_name": "Coltrane",
  "birthday": "1980-01-01",
  "phone": "666112233",
  "language": "es",
  "date_joined": "2014-08-21T13:56:45+0000",
  "last_login": "2014-08-27T19:57:56+0000",
  "address": {
    "phone": "666112233",
    "alt_phone": "+34917909930",
    "street": "Plaza del Angel nº10",
    "address_addition": "Cerca de la plaza Santa Ana",
    "city": "Madrid",
    "state": "Madrid",
    "country": "ES",
    "postcode": "28012"
  }
}
Parámetro Tipo Requerido Descripción
id string no ID del cliente
email string si Correo del cliente
type char no Tipo de cliente; las opciones son g invitado, n nuevo, e existente
gender integer no Género; las opciones son 0 desconocido, 1 hombre, 2 mujer, 3 no aplica
first_name string no Nombre
last_name string no Apellidos
phone string no Número de teléfono del cliente
birthday ISO 8601 no Fecha de nacimiento
language ISO 639-1 no Preferencias de idioma
date_joined ISO 8601 no Fecha que designa cuando se creó la cuenta.
last_login ISO 8601 no Fecha del último inicio de sesión.
address object no Dirección

customer.address

{
  "phone": "666112233",
  "alt_phone": "+34917909930",
  "street": "Plaza del Angel nº10",
  "address_addition": "Cerca de la plaza Santa Ana",
  "city": "Madrid",
  "state": "Madrid",
  "country": "ES",
  "postcode": "28012"
}
Parámetro Tipo Requerido Descripción
phone string no Número de teléfono de la dirección
alt_phone string no Número de teléfono alternativo
street string si Dirección
address_addition string no Línea adicional
city string si Municipio / ciudad
state string si Estado / provincia
country ISO 3166-1 si Código de país
postcode string si Código postal

billing

{
  "first_name": "Bill",
  "last_name": "Evans",
  "phone": "+34914298407",
  "alt_phone": null,
  "street": "Calle de Las Huertas 22",
  "address_addition": "Cerca de la pizzería",
  "city": "Madrid",
  "state": "Madrid",
  "country": "ES",
  "postcode": "28014"
}
Parámetro Tipo Requerido Descripción
first_name string si Nombre
last_name string si Apellido
phone string no Número de teléfono de la dirección
alt_phone string no Número de teléfono alternativo
street string si Dirección
address_addition string no Línea adicional
city string si Municipio / ciudad
state string si Estado / provincia
country ISO 3166-1 si Código de país
postcode string si Código postal

shipping

{
  "first_name": "Django",
  "last_name": "Reinhard",
  "phone": "666112233",
  "alt_phone": "+34917909930",
  "street": "Plaza del Angel nº10",
  "address_addition": "Cerca de la plaza Santa Ana",
  "city": "Madrid",
  "state": "Madrid",
  "country": "ES",
  "postcode": "28012",
  "price": 500,
  "tax_rate": 2100,
  "name": "Planet Express",
  "discount": 100,
  "method": "postal"
}
Parámetro Tipo Requerido Descripción
first_name string si Nombre
last_name string si Apellido
phone string no Número de teléfono de la dirección
alt_phone string no Número de teléfono alternativo
street string si Dirección
address_addition string no Línea adicional
city string si Municipio / ciudad
state string si Estado / provincia
country ISO 3166-1 si Código de país
postcode string si Código postal
name string si Nombre del envío
price decimal si Precio del envío (impuestos no incluidos)
tax_rate decimal no Tasa de impuestos en el precio del envío
discount decimal no Cantidad de descuento en el precio del envío
discount_rate decimal no Tasa de descuento en el precio del envío
method string no Método de envío; las opciones son pickup_store recogida en tienda, pickup_point punto de recogida, postal envio por correo.