Pagos

Es la entidad que almacena la información específica de pagos asociados a pedido. Ya que un pedido puede tener uno (o múltiples) pagos aplicados y los pagos aplicados pueden originarse de un mismo método de pago o una combinación de distintos métodos de pago.

Listado de todos los métodos de pago

GET https://tiendagoshop.com/api/v1/payment_methods

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "payment_methods": [
    {
      "id": 1,
      "type": "Spree::PaymentMethod::Check",
      "name": "Transferencia bancaria",
      "description": "",
      "active": true,
      "display_on": "both",
      "preferences": {},
      "auto_capture": null,
      "code": null,
      "created_at": "2020-09-30T13:14:33.743Z",
      "updated_at": "2020-09-30T13:14:33.743Z"
    }
  ],
  "count": 1,
  "current_page": 1,
  "pages": 1
}

Obtener todos los pagos de un pedido

GET https://tiendagoshop.com/api/v1/orders/:order_number/payments

Path Parameters

Name	Type	Description
order_number	integer	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

Crear un pago para un pedido

POST https://tiendagoshop.com/api/v1/orders/:order_number/payments

Path Parameters

Name	Type	Description
order_number	string	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

Request Body

Name	Type	Description
payment_method_id	integer	ID del método de pago
amount	number	Monto del pago.

200

{
  "id": 8,
  "source_type": null,
  "source_id": null,
  "amount": "770.0",
  "display_amount": "RD$ 770.00",
  "payment_method_id": 1,
  "state": "checkout",
  "avs_response": null,
  "created_at": "2020-10-05T08:31:32.070Z",
  "updated_at": "2020-10-05T08:31:32.070Z",
  "number": "P4OFJGU0",
  "order_id": 1
}

Obtener un pago en específico de un pedido

GET https://tiendagoshop.com/api/v1/orders/:order_number/payments/:number

Path Parameters

Name	Type	Description
order_number	string	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "id": 1,
  "source_type": null,
  "source_id": null,
  "amount": "770.0",
  "display_amount": "RD$ 770.00",
  "payment_method_id": 1,
  "state": "void",
  "avs_response": null,
  "created_at": "2020-09-30T13:14:39.967Z",
  "updated_at": "2020-09-30T15:17:04.436Z",
  "number": "P1FE09VX",
  "order_id": 1
}

Detalle de un pago relacionado a un pedido.

GET https://tiendagoshop.com/api/v1/orders/:order_number/payments/:number_payment/

Path Parameters

Name	Type	Description
number_payment	string	Número de pago
order_number	string	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "id": 7,
  "source_type": null,
  "source_id": null,
  "amount": "770.0",
  "display_amount": "RD$ 770.00",
  "payment_method_id": 1,
  "state": "completed",
  "avs_response": null,
  "created_at": "2020-10-05T08:27:43.098Z",
  "updated_at": "2020-10-05T08:27:57.036Z",
  "number": "P52PTRFP",
  "order_id": 1
}

Cancelar un pago en específico de un pedido

PUT https://tiendagoshop.com/api/v1/orders/:order_number/payments/:payment_number/void

Path Parameters

Name	Type	Description
payment_number	string	Número de pago
order_number	string	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "id": 7,
  "source_type": null,
  "source_id": null,
  "amount": "770.0",
  "display_amount": "RD$ 770.00",
  "payment_method_id": 1,
  "state": "void",
  "avs_response": null,
  "created_at": "2020-10-05T08:27:43.098Z",
  "updated_at": "2020-10-05T08:28:57.821Z",
  "number": "P52PTRFP",
  "order_id": 1
}

Acción de Capturar el pago.

PUT https://tiendagoshop.com/api/v1/orders/:order_number/payments/:payment_number/capture

Path Parameters

Name	Type	Description
payment_number	string	Número de pago
order_number	string	Número de orden

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "id": 7,
  "source_type": null,
  "source_id": null,
  "amount": "770.0",
  "display_amount": "RD$ 770.00",
  "payment_method_id": 1,
  "state": "completed",
  "avs_response": null,
  "created_at": "2020-10-05T08:27:43.098Z",
  "updated_at": "2020-10-05T08:27:57.036Z",
  "number": "P52PTRFP",
  "order_id": 1
}