SDK Javascript
Integración
Debes incluir aplazame.js en las páginas del botón y del checkout.
- aplazame.js
- requirejs
<script
src="https://cdn.aplazame.com/aplazame.js?public-key=api_public_key&sandbox=true"
async defer>
</script>
requirejs.config({
paths: {
aplazame: 'https://cdn.aplazame.com/aplazame.js'
}
});
require(['aplazame'], function (aplazame) {
aplazame.init({
// reemplazar con la public key del merchant
public_key: "api_public_key",
sandbox: true
});
aplazame.checkout({
// ...
});
});
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| public-key | string | Sí | Tu clave pública. |
| sandbox | boolean | Sí | Indica si las peticiones usarán el modo de pruebas (true) o producción (false). |
Para producción el valor de sandbox debe ser false.
Comprobar productos de financiación disponibles
Para mostrar el botón de pago con Aplazame en función de los productos configurados en tu cuenta:
- html
- aplazame.js
- http
<button type="button"
data-aplazame-button
data-amount="12050"
data-currency="EUR"></button>
<div data-aplazame-payment-info="">
Información acerca del pago con Aplazame que aparecerá y se ocultará con el botón
</div>
(window.aplazame = window.aplazame || []).push(function (aplazame)
aplazame.button(
selector: '#some-button-or-wrapper-id', // se acepta cualquier selector CSS válido
amount: 12050,
currency: 'EUR'
)
)
Request:
GET /checkout/button?amount=12050¤cy=EUR
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer $api_tokenpublic
Host: api.aplazame.com
Response (available for this credit):
HTTP/1.1 201 OK
Response (not available for this credit):
HTTP/1.1 403 Forbidden
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| selector | css selector | No | Selector CSS para mostrar/ocultar el método de pago Aplazame. |
| amount | decimal | Sí | Cantidad a financiar. |
| currency | ISO 4217 | Sí | Código de la moneda del pedido. |
Comprobar Pago a plazos
Para mostrar el botón de pago con Aplazame en función de los límites configurados en tu cuenta.
Los ejemplos anteriores usarán "Pago a plazos" (valor por omisión).
Comprobar Pago en 15 días
Para mostrar el botón de pago con Aplazame en función de los límites configurados en tu cuenta.
Para comproabr la disponibilidad del producto "Pay later", debes añadir data-product-type="pay_later", o product: { type: 'pay_later' }:
- html
- aplazame.js
- http
<button type="button"
data-aplazame-button
data-amount="12050"
data-currency="EUR"
data-product-type="pay_later"></button>
<div data-aplazame-payment-info="">
Información acerca del pago con Aplazame que aparecerá y se ocultará con el botón
</div>
(window.aplazame = window.aplazame || []).push(function (aplazame)
aplazame.button(
selector: '#some-button-or-wrapper-id', // se acepta cualquier selector CSS válido
amount: 12050,
currency: 'EUR'
product: {
type: 'pay_later'
}
)
)
Request:
GET /checkout/button?amount=12050¤cy=EUR&product[type]=pay_later
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer $api_tokenpublic
Host: api.aplazame.com
Response (available for this credit):
HTTP/1.1 201 OK
Response (not available for this credit):
HTTP/1.1 403 Forbidden
Comprobar Pago en 4
Para mostrar el botón de pago con Aplazame en función de los límites configurados en tu cuenta.
Para comproabr la disponibilidad del producto "Paga en 4", debes añadir data-product-type="pay_in_4", o product: { type: 'pay_in_4' }:
- html
- aplazame.js
- http
<button type="button"
data-aplazame-button
data-amount="12050"
data-currency="EUR"
data-product-type="pay_in_4"></button>
<div data-aplazame-payment-info="">
Información acerca del pago con Aplazame que aparecerá y se ocultará con el botón
</div>
(window.aplazame = window.aplazame || []).push(function (aplazame)
aplazame.button(
selector: '#some-button-or-wrapper-id', // se acepta cualquier selector CSS válido
amount: 12050,
currency: 'EUR'
product:
type: 'pay_in_4'
)
)
Request:
GET /checkout/button?amount=12050¤cy=EUR&product[type]=pay_in_4
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer $api_tokenpublic
Host: api.aplazame.com
Response (available for this credit):
HTTP/1.1 201 OK
Response (not available for this credit):
HTTP/1.1 403 Forbidden
Inicio del checkout
Aquí puedes consultar como integrar el SDK
<script>
(window.aplazame = window.aplazame || []).push(function (aplazame)
// Esta función se ejecuta cuando aplazame.js esté listo
aplazame.checkout(checkout_id,
// callbacks ...
)
)
</script>
Mostrar resultado
;(window.aplazame = window.aplazame || []).push(function (aplazame) {
// Esta función se ejecuta cuando aplazame.js esté listo
aplazame.checkout(checkout_id,
onStatusChange (result_status) {
console.log('IMPORTANTE: EL CHECKOUT TODAVÍA SIGUE ABIERTO')
switch (result_status) {
case 'success':
console.log('el checkout ha sido completado correctamente')
break
case 'pending':
console.log('el checkout ha terminado pero está pendiente de ser validado')
break
case 'ko':
console.log('el proceso de pago ha sido rechazado por parte de Aplazame')
break
}
},
onClose (result_status) {
switch (result_status) {
case 'success': // equivalente a onSuccess
console.log('el checkout ha sido completado correctamente')
break
case 'pending': // equivalente a onPending
console.log('el checkout ha terminado pero está pendiente de ser validado')
break
case 'error': // equivalente a onError
console.log('ha ocurrido un error al cargar el checkout')
break
case 'dismiss': // equivalente a onDismiss
console.log('el usuario ha cerrado el checkout sin haberlo completado')
break
case 'ko': // equivalente a onKO
console.log('el proceso de pago ha sido rechazado por parte de Aplazame')
break
}
})
})
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| onStatusChange | function | No | function onStatusChange(status) { /**/} Función a la que se llamará cuando el Checkout cambie de estado. Posibles estados: success, pending, ko. (Al enviar esta señal, el checkout seguirá abierto hasta que se llame a algún callback abajo mencionado). |
| onClose | function | No | Función a la que se llamará cuando el Checkout se cierre. function onClose(status) { /**/} Posibles estados: success, pending, ko, dismiss. |
| onSuccess | function | No | Función a la que se llamará cuando se haya completado el pago. Al definir esta función el valor de success_url es ignorado. |
| onPending | function | No | Función a la que se llamará cuando el pago quede pendiente de confirmación. Al definir esta función el valor de pending_url es ignorado. |
| onKO | function | No | Función a la que se llamará cuando se haya denegado el pago. Al definir esta función el valor de ko_url es ignorado. |
| onError | function | No | Función a la que se llamará cuando haya habido un error. Al definir esta función el valor de error_url es ignorado. |
| onDismiss | function | No | Función a la que se llamará cuando el usuario escoge volver a la tienda. Al definir esta función el valor de dismiss_url es ignorado. |