Obtener reporte desglosado de depósitos

get

https://api-gw.payclip.com/settlements/{settlement_report_id}

Genera un reporte con los detalles del depósito basado en su Settlement Report ID.

Este endpoint devuelve los detalles completos de un depósito individual, incluyendo los pagos que lo componen, cargos, propinas, método de pago, entre otros.

🚧
Importante
No se debe utilizar el settlement_report_id como parámetro en la URL.
El valor correcto es un UUID que se obtiene desde la propiedad links.self.href del objeto cuando se llama al endpoint:
GET /settlements?from={fecha_inicio}&to={fecha_fin}

Ejemplo de flujo de uso

Realiza una llamada al endpoint obtener resumen de depósitos por periodo

GET /settlements?from=2025-03-01&to=2025-03-10

Esto genera un listado resumido de depósitos realizados en el periodo indicado. Es ideal para obtener una visión general y localizar depósitos específicos a detallar.

En la respuesta, identifica el href dentro del objeto links.self

"links": {
  "self": {
    "href": "/settlements/e3e5116c-639b-41da-b3bf-202c8c5d7834"
  }
}

Este href contiene el UUID único que identifica ese depósito en particular. Es un valor esencial para obtener el detalle completo del depósito

Copia el UUID del href y realiza una nueva llamada para obtener el detalle

GET /settlements/e3e5116c-639b-41da-b3bf-202c8c5d7834

Esta llamada retornará un reporte exhaustivo del depósito

{
  "settlement": {
    "settlement_report_id": "W472RZQKV",
    "merchant_name": "Clip",
    "disbursement_date": "2022-01-13",
    "gross_amount": 9300,
    "disbursed_net_amount": 8911.62,
    "total_transactions": 22,
    "details": [
      {
        "date": "2022-01-10",
        "payments": [
          {
            "receipt_no": "liNzWOR",
            "payment_date": "2022-01-10",
            "amount": 100,
            "terms": null,
            "charges": {
              "charge": {
                "fee": 3.6,
                "tax": 0.58
              }
            },
            "tip": 0,
            "total_retention": 4.18,
            "settled_amount": 95.82,
            "payment_method": "Credit",
            "card": {
              "brand": "Mastercard",
              "last4": 4352,
              "issuer": "BANAMEX"
            },
            "merchant_invoice": null,
            "user_email": "[email protected]"
          }
        ]
      }
    ]
  },
  "links": {
    "next": {
      "href": "/settlements/GHWRWSFLW?page_size=1&page=eyJjb21wbZSJ9fX0=",
      "method": "GET"
    }
  }
}

Errores comunes

Código HTTP		Response	Description
400		settlement_id Invalid pattern	Se usó un settlement_report_id en vez de un UUID válido
401		Unauthorized	Falta el token de autenticación

Llamada de prueba

Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra abajo.

Recuerda que necesitas tu token de autenticación para realizar las llamadas a la API.

Responses

400

Bad request.

401

Unauthorized.

403

Forbidden.

500

Internal Server Error.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.com.payclip.v2+json