Captura del pedido

Se ha de realizar una captura cuando se proceda al envío del producto o productos por el total del valor de los mismos. El importe de la captura debe corresponder al importe total del pedido menos el importe total de los artículos anulados.

{
    "amount": 10050,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 0
}
Parámetro Tipo Requerido Descripción
amount decimal si Importe de la captura
id string si id de la captura
created string si Fecha de la captura
refunds object no Devoluciones realizadas a la captura.
refunded_amount decimal si Cantidad devuelta de la captura
remaining_amount decimal si Cantidad restante de la captura (Siempre será 0)

01. Detalle de la captura

GET /orders/:orderId/captures HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Parámetro Tipo Requerido Descripción
:orderId string si ID del pedido.

Respuesta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "remaining_capture_amount": 60020,
    "results": [
        {
            "amount": 10050,
            "id": "cf04aa87a6364f14b164e48a84e99936",
            "created": "2019-06-21T16:51:19.494155+02:00",
            "refunds": [],
            "refunded_amount": 0,
            "remaining_amount": 10050
        }
    ]
}
Parámetro Tipo Descripción
remaining_capture_amount decimal Cantidad restante del pedido sin capturar (Siempre será 0)
results object Capturas del pedido

02. Solicitar captura

POST /orders/:orderId/captures HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

{
  "amount": 10050
}
Parámetro Tipo Requerido Descripción
:orderId string si ID del pedido.
amount decimal si Importe a capturar

Respuesta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "remaining_capture_amount": 49970,
    "amount": 10050,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 10050
}
Parámetro Tipo Descripción
remaining_capture_amount decimal Cantidad restante del pedido sin capturar (Siempre será 0)
amount decimal Importe de la captura
id string id de la captura
created string Fecha de la captura
refunds object Devoluciones realizadas a la captura.
refunded_amount decimal Cantidad devuelta de la captura
remaining_amount decimal Cantidad restante de la captura (Siempre será 0)