Los endpoints de Card Information te dan herramientas de consulta para los flujos presenciales en México 🇲🇽: obtener el tipo de tarjeta y la disponibilidad de MSI a partir de un BIN, consultar las opciones de diferido de una tarjeta específica y listar las transacciones registradas en una terminal POS.
Resumen de endpoints#
| Endpoint | Propósito |
|---|
POST /pos/v1/bin | Consulta de BIN — devuelve el tipo de tarjeta y la disponibilidad de MSI |
GET /deferred/v2/bin/{bin} | Opciones MSI v2 — tipos de diferido y meses para un BIN |
GET /card/v1/deferred/{bin} | Opciones MSI v1 — meses de diferido disponibles para un BIN |
POST /pos-analytics/v1/transactions/search | Lista de transacciones — consulta las transacciones de una terminal POS |
Consulta de BIN#
Llama a POST /pos/v1/bin con el BIN de la tarjeta (primeros 6–8 dígitos) para saber si la tarjeta admite MSI antes de continuar.{
"bin": "43810200",
"pos_details": {
"terminal_id": "PB04209860189",
"brand": "SUNMI",
"model": "P2-EU",
"version": "Kushki SunmiV1.1.28"
}
}
{
"card_type": "credit",
"country": "MEX",
"deferred": true
}
| Campo de respuesta | Descripción |
|---|
card_type | "credit", "debit" o "prepaid". |
country | ISO 3166-1 alpha-3 del país emisor de la tarjeta. |
deferred | true si la tarjeta admite pagos diferidos MSI. |
Opciones MSI#
Usa estos endpoints para obtener las configuraciones de MSI válidas de un BIN antes de crear un cargo diferido. Consulta siempre primero las opciones de MSI: los meses disponibles dependen del BIN específico de la tarjeta.Los MSI solo están disponibles para tarjetas de crédito.
v2 — GET /deferred/v2/bin/{bin}#
Devuelve los metadatos de la tarjeta junto con las opciones de diferido.GET /deferred/v2/bin/43810200
Public-Merchant-Id: <your-public-key>
| Campo | Descripción |
|---|
bank | Nombre del banco emisor. |
brand | Marca de la tarjeta (por ejemplo, "visa", "mastercard"). |
cardType | "credit", "debit" o "prepaid". |
country | País emisor de la tarjeta. |
v1 — GET /card/v1/deferred/{bin}#
Devuelve los meses de MSI disponibles para un BIN.GET /card/v1/deferred/43810200
Public-Merchant-Id: <your-public-key>
[
{
"months": ["3", "6", "9", "12", "18"],
"monthsOfGrace": ["00"],
"type": "03"
}
]
Valor de type | Significado |
|---|
"03" | MSI (Meses Sin Intereses). Envía el valor de months que devuelve la consulta dentro del objeto deferred del cargo. |
Usa los valores de type y months de esta respuesta para construir el objeto deferred en el request del cargo.
Lista de transacciones#
POST /pos-analytics/v1/transactions/search devuelve una lista de las transacciones registradas en una terminal POS. page y size son obligatorios; usa filters para acotar la búsqueda. Consulta Consultar transacciones para el contrato completo.Devuelve un máximo de 10.000 transacciones.
{
"page": 1,
"size": 10,
"filters": {
"start_date": 1712286000000,
"end_date": 1712322035152,
"transaction_type": "charge"
}
}
| Campo | Descripción |
|---|
transaction_reference | Referencia de la transacción del lado del comercio. |
transaction_status | APPROVED, DECLINED, VOIDED o REFUNDED. |
transaction_type | Tipo de la transacción original. |
payment_brand | Marca de la tarjeta usada (por ejemplo, "VISA", "MASTERCARD"). |
reading_type | ICC, MCR o NFC. |
amount | Objeto con los totales de la transacción. |
deferred | Detalles del diferido MSI, si aplica. |
merchant_id | Identificador del comercio. |
pos_details | Detalles de la terminal. |
Autenticación#
| Endpoint | Cabecera |
|---|
POST /pos/v1/bin | Private-Credential-Id: <your-private-credential> |
POST /pos-analytics/v1/transactions/search | Private-Credential-Id: <your-private-credential> |
GET /deferred/v2/bin/{bin} | Public-Merchant-Id: <your-public-key> |
GET /card/v1/deferred/{bin} | Public-Merchant-Id: <your-public-key> |
Usar la API#
https://api.kushkipagos.com/
Endpoints disponibles#
Consulta de BIN
Consulta el BIN de una tarjeta para obtener el tipo de tarjeta y la disponibilidad de MSI.
Opciones MSI v2
Obtén los metadatos del BIN y las configuraciones de MSI disponibles (v2).
Opciones MSI v1
Obtén los meses de MSI disponibles para un BIN (v1).
Lista de transacciones
Consulta las transacciones registradas en una terminal POS con filtros opcionales.
¿Tienes una sugerencia sobre esta documentación? Escríbenos.
