Listar objetos Payment

GET /v3/payments

Ambiente	URL base API	Portal de comercio
Sandbox	https://api.virtualpos-sandbox.com	comercios.virtualpos-sandbox.com
Producción	https://api.virtualpos.cl	comercios.virtualpos.cl

Parámetros de consulta

Nombre	Tipo	Requerido	Descripción
status	string	No	Estado del objeto payment Valores: pendiente, pagado, suspendido, expirado, reintentando, rechazado, anulado, autorizando, cancelado.
merchant_internal_code	string	No	Identificador de su negocio que representa el pago, ejemplo: número de pedido, factura, etc.
authorization_from	string	No	Límite inferior para la fecha de autorización del pago.
authorization_to	string	No	Límite superior para la fecha de autorización del pago.
created_from	string	No	Límite inferior para la fecha de creación del pago.
created_to	string	No	Límite superior para la fecha de creación del pago.

Ejemplo de request

curl -X GET 'https://api.virtualpos-sandbox.com/v3/payments' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE"

Respuestas

200 OK

{
  "status": "OK",
  "code": 200,
  "pagination": {
    "limit": 1,
    "page": 1,
    "pages": 2,
    "total": 6
  },
  "commerce": {
    "commerce_id": "76123456-7",
    "name": "Comercial Andes"
  },
  "payments": {
    "client": {
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "social_id": "12345678-9",
      "phone": "56961934502"
    },
    "order": {
      "uuid": "083613a748190d26",
      "status": "pagado",
      "created_at": "2021-09-08 11:20:31",
      "card_number": 1234,
      "authorized_at": "2021-09-08 11:21:31",
      "auth_code": "1234",
      "installment_amount": 0,
      "installment_number": 0,
      "payment_type_code": "VN",
      "amount": 9990,
      "merchant_internal_code": "OC-1234",
      "merchant_internal_channel": "portal_pagos",
      "deposits": [
        {
          "description": "1/1",
          "installment": 9900,
          "processing_flat_fee": 0,
          "processing_fee": 117,
          "payout_amount": 9783,
          "payout_date": "2021-09-21"
        }
      ]
    }
  }
}

400 Bad Request

{
  "status": "NOK",
  "code": 400,
  "error": {
    "error_code": "E-###",
    "message": "detalle del error",
    "doc_url": "https://virtualpos.readme.io/reference/objeto-error"
  }
}