Saltar al contenido principal
PapelPay es el método de pago con tarjeta de su tienda PapelShip. Con la Store API usted crea un pedido, inicia su pago con PapelPay y permite que el cliente pague con tarjeta en su checkout alojado o en un formulario de tarjeta en su propio sitio. Los pedidos de productos vendidos como suscripción se vuelven a cobrar en cada periodo de facturación.
PapelPay debe estar activo en su tienda. Solicítelo en el panel, en PapelPay; los endpoints de esta página devuelven PAPELPAY_NOT_ENABLED hasta que su tienda sea aprobada.

Cómo funciona un pago con tarjeta

1

Cree el pedido

Llame a POST /api/v1/invoices con el cliente y los productos, como en Crear y gestionar pedidos. Agregue auto_renew para vender un producto de suscripción como suscripción o como compra única. Consulte Suscripciones.
2

Inicie el pago con tarjeta

Llame a POST /api/v1/invoices/{invoiceId}/papelpay, o envíe "payment_method": "PAPELPAY" al crear el pedido para hacer ambas cosas en una sola llamada. La respuesta contiene un objeto payment.
3

Permita que el cliente pague

Envíe al cliente a payment.payment_url, su checkout alojado abierto en el formulario de tarjeta. Para mantener al cliente en su sitio, monte payment.embed_url con el SDK de JavaScript. Consulte Formulario de tarjeta en su sitio.
4

Confirme el pedido

Cuando se cobra la tarjeta, el pedido pasa a completed y PapelShip entrega los productos. Escuche el webhook order.completed o consulte el pedido con GET /api/v1/invoices/{invoiceId}. Consulte Webhooks.

Iniciar el pago con tarjeta

Respuesta (200)
Si vuelve a llamar al endpoint mientras el pago está abierto, obtiene el mismo session_id. Use el ID del pedido en su Idempotency-Key.

El objeto de pago

Errores

Cuando envía "payment_method": "PAPELPAY" al crear y el pago con tarjeta no puede iniciarse, el pedido sigue existiendo. El details.invoice_id del error lo indica, para que pueda reintentar con POST /invoices/{invoiceId}/papelpay.

Próximos pasos

Suscripciones

Venda un producto como suscripción y siga sus renovaciones.

Formulario de tarjeta en su sitio

Muestre el formulario de tarjeta en su propia página de checkout.