Captura del pedido

Se ha de realizar una captura cuando se proceda al envio del producto o productos por el valor de los mismos.

Se soporta la creación de múltiples capturas por si se realizan envios parciales del pedido. El sumatorio del importe de las capturas nunca puede superior al valor del pedido.

{
    "amount": 10050,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 10050
}
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

01. Comprobar cantidad restante

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
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
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