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
hrefdentro del objetolinks.self
"links": {
"self": {
"href": "/settlements/e3e5116c-639b-41da-b3bf-202c8c5d7834"
}
}
Este
hrefcontiene 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
hrefy 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": "user@example.com"
}
]
}
]
},
"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.