La API de Depósitos esta diseñada para obtener la información referente a los depósitos realizados en los últimos 90 días. De la misma manera y con la información de los depósitos consultados se puede obtener un reporte detallado de sus transacciones.
Importante
Para poder utilizar la API de Depósitos, necesitas solicitar acceso. Envíanos una solicitud con el botón Ayuda ubicado en esta página o envíanos un correo a [email protected]. No olvides proporcionar el correo de tu cuenta Clip en la solicitud.
El recurso Settlements
La siguiente tabla contiene los elementos de la estructura del objeto settlements:
{
"settlements": [
{
"disbursement_date": "2020-01-13",
"settlement_report_id": "W472RZQKV",
"gross_amount": 9300,
"total_fee": 360,
"total_tax": 62.14,
"total_retention": 388.38,
"disbursed_net_amount": 8911.62,
"total_transactions": 22,
"links": {
"self": {
"href": "/settlements/W472RZQKV",
"method": "GET"
}
}
}
]
}
|
Elemento |
Descripción |
Tipo |
|||||
|
settlements |
Arreglo de objetos del tipo settlements |
array |
|||||
|
|
disbursement_date |
Fecha de pago |
string |
||||
|
|
settlement_report_id |
ID del reporte de depósitos |
string |
||||
|
|
gross_amount |
Cantidad total antes de impuestos |
number |
||||
|
|
total_fee |
Cantidad total de comisión sobre la cantidad antes de impuestos |
number |
||||
|
|
total_tax |
Cantidad de impuestos por IVA sobre la comisión |
number |
||||
|
|
total_retention |
Cantidad total de comisión e impuestos a deducir |
number |
||||
|
|
disbursed_net_amount |
Cantidad a depositar después de impuestos |
number |
||||
|
|
total_transactions |
Total de transacciones que incluye el reporte |
string |
||||
|
|
links |
Objeto de tipo links. |
string |
||||
El recurso Settlement
La siguiente tabla contiene los elementos de la estructura del objeto settlement:
{
"settlement": {
"settlement_report_id": "W472RZQKV",
"merchant_name": "Clip",
"disbursement_date": "2020-01-13",
"gross_amount": 9300,
"disbursed_net_amount": 8911.62,
"total_transactions": 22,
"details": [
{
"date": "2020-01-10",
"payments": [
{
"receipt_no": "liNzWOR",
"payment_date": "2020-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"
}
}
}
|
Elemento |
Descripción |
Tipo |
|||||||||
|
settlement |
Objeto de tipo settlement |
object |
|||||||||
|
|
settlement_report_id |
ID del reporte de depósitos a detallar |
string |
||||||||
|
|
merchant_name |
Nombre del comerciante |
string |
||||||||
|
|
disbursement_date |
Fecha de pago |
string |
||||||||
|
|
gross_amount |
Total antes de impuestos |
number |
||||||||
|
|
disbursed_net_amount |
Cantidad a depositar después de impuestos |
number |
||||||||
|
|
total_transactions |
Total de transacciones que contiene el reporte |
string |
||||||||
|
|
details |
Arreglo de objetos con el esquema details |
array |
||||||||
|
|
|
date |
Fecha del reporte |
string |
|||||||
|
|
|
payments |
Arreglo de objetos con el esquema payment |
array |
|||||||
|
|
|
|
receipt_no |
ID de la transacción |
string |
||||||
|
|
|
|
payment _date |
Fecha de creación del reporte |
string |
||||||
|
|
|
|
amount |
Monto de la transacción en pesos |
float |
||||||
|
|
|
|
terms |
Indica si el pago está diferido en mensualidades. Cuando el pago no está diferido, su valor es null. Mensualidades disponibles: 3, 6, 9 y 12 |
string |
||||||
|
|
|
|
charges |
Objeto que contiene la información relacionada a los distintos cargos del pago |
object |
||||||
|
|
|
|
|
charge |
Objeto de tipo charge |
object |
|||||
|
|
|
|
|
|
fee |
Comisión en pesos |
float |
||||
|
|
|
|
|
|
tax |
Cantidad de IVA |
float |
||||
|
|
|
|
|
surcharge |
Objeto de tipo surcharge con información de la comisión por mensualidades. Se calcula con base en el valor del campo terms del objeto payments de esta respuesta. NOTA: este campo aún no está implementado, por lo que su valor es nulo. |
object |
|||||
|
|
|
|
tip |
Monto de la propina en pesos |
float |
||||||
|
|
|
|
total_retention |
Retención total en pesos |
float |
||||||
|
|
|
|
settled_amount |
Cantidad a depositar |
float |
||||||
|
|
|
|
payment_method |
Especifica la categoría de la forma de pago:
|
string |
||||||
|
|
|
|
card |
Objeto que contiene detalles de la tarjeta utilizada. |
object |
||||||
|
|
|
|
|
brand |
Tipo de tarjeta utilizada para el pago |
string |
|||||
|
|
|
|
|
last4 |
Últimos cuatro dígitos de la tarjeta utilizada para el pago |
string |
|||||
|
|
|
|
|
issuer |
Banco emisor de la tarjeta |
string |
|||||
|
|
|
|
merchant_invoice |
Número proporcionado por el merchant para referencia |
string |
||||||
|
|
|
|
user_email |
Correo electrónico del usuario de Clip |
string |
||||||
|
links |
Objeto de tipo links |
object |
|||||||||
¿Necesitas ayuda?
Si tienes preguntas sobre cómo hacer la integración de la API, puedes contactar a nuestros desarrolladores técnicos mediante los siguientes pasos:
- Crear un ticket al seleccionar el botón Ayuda disponible en la parte inferior derecha de este sitio.
- Llena la información solicitada y envía tu solicitud de ayuda. Te responderemos en alrededor de 2 horas en días laborables.
También puedes contactarnos en nuestra área de Customer Happiness:
- Portal web
- Llámanos al 55 6393-2323 Clip es el único con atención personalizada 24/7 los 365 días del año.
- Envíanos un mensaje por WhatsApp al 55 6393-2323 y te atenderemos.
- Escríbenos al correo [email protected]