Permite conocer los tipos de pagos a meses aceptados para un monto y tipo de tarjeta especificados.
Proporcionando el monto y ya sea el número BIN o el método de pago, este endpoint te devuelve una lista de cuotas aceptadas para los parámetros dados para que puedas ofrecerlas a tu cliente.
Debes proporcionar el número BIN y el monto o el id del método de pago y el monto.
Los IDs de los métodos de pago disponibles se pueden obtener del endpoint GET/payment_methods
Header parameters (parámetros del encabezado)
La siguiente tabla describe el esquema de los parámetros del encabezado:
|
Parámetro |
Descripción |
Tipo |
Requerido / Opcional |
Notas |
|
|
Content-Type |
Define el formato del objeto de la llamada |
application/json |
Requerido |
Solicitud en formato JSON |
|
|
Authorization |
Especifica el token de acceso |
String |
Requerido |
token de autenticación |
|
Query parameters (parámetros del cuerpo de la solicitud)
La siguiente tabla describe el esquema de los parámetros de consulta:
|
Parámetro |
Descripción |
Tipo |
Ejemplo |
Requerido / Opcional |
Notas |
|
|
amount |
Monto de la transacción |
Float |
100.50 |
Requerido |
Acepta hasta 2 decimales. |
|
|
country |
Código del País |
String |
“MX” |
Opcional |
Código del país en formato ISO 3166-1 alpha-2 code. Valor por defecto: MX |
|
|
bin |
Número BIN |
String |
“424242” |
Opcional |
Número BIN a 6 dígitos. |
|
|
payment_method_id |
ID del método de pago. |
String |
“visa” |
Opcional |
ID del método de pago. Posibles valores: amex, visa, master, arcuspay. |
|
Respuesta
La respuesta contiene todos los elementos enviados en el body más los campos que se muestran en la siguiente tabla:
|
Parámetro |
Descripción |
Tipo |
Ejemplo |
Notas |
||
|
id |
id del método de pago. |
String |
“amex” |
Identificación del método de pago. Posibles valores: amex, visa, master, arcuspay. Arcuspay hace referencia a Clip Cash o pago en efectivo. |
||
|
logo |
URL con la imágen del método de pago. |
String |
“https://url.com/ logoamex.png” |
URL del logotipo del método de pago. |
||
|
name |
Nombre del método de pago. |
String |
“American Express” |
Nombre completo del método de pago. Posibles valores:American Express, Visa, Mastercard y Arcus Pay. |
||
|
status |
Status del método de pago. |
String |
“active” |
Posibles valores: active, deactive. |
||
|
type |
Tipo de tarjeta. |
String |
“credit_card” |
Posibles valores: credit_card, debit_card, ticket (efectivo). Posibles valores: amex, visa, master, arcuspay. Arcuspay hace referencia a Clip Cash o pago en efectivo. |
||
|
validations |
Objeto con los tipos de validación. |
Objeto |
|
|
||
|
|
name |
Nombre del tipo de validación. |
String |
"card_number" |
Posibles valores:bin, card_number, cvv, accepted_amount. | |
|
|
metadata |
Objeto con los valores del tipo de validación . |
Object |
|
| |
|
|
|
pattern |
Patrón del número BIN. |
String |
“^(3)” |
valor asociado con el tipo de validación “bin” |
|
|
|
exclusion_pattern |
Patrón de exclusión. |
String |
|
valor asociado con el tipo de validación “bin” |
|
|
|
installments_pattern |
Meses sin interested disponibles para el número BIN. |
String |
“^(360935)” |
valor asociado con el tipo de validación “bin” |
|
|
|
algorithm |
Algoritmo del número de tarjeta. |
String |
“luhn” |
valor asociado con el tipo de validación “card_number” |
|
|
|
length |
Longitud del número de la tarjeta. |
String |
16 |
valor asociado con el tipo de validación “card_number” |
|
|
|
card_location |
Ubicación del número CVV. |
String |
"back" |
valor asociado con el tipo de validación “cvv” Posibles valores: front o back |
|
|
|
type |
Indica si el CVV es obligatorio u opcional. |
String |
"mandatory" |
valor asociado con el tipo de validación “cvv” |
|
|
|
min |
Monto mínimo aceptado para este método de pago. |
number |
1 |
valor asociado con el tipo de validación “accepted_amount” |
|
|
|
max |
Monto máximo aceptado para este método de pago. |
number |
300000 |
valor asociado con el tipo de validación “accepted_amount”. |
|
installments |
Objeto con la información de las cuotas diferidas disponibles. |
Objeto |
|
|
||
|
|
quantity |
Número de cuotas mensuales. |
Number |
3 |
Posibles valores: 1,3,6,9,12,18,24. | |
|
|
fee |
Comisión. |
Float |
7.91 |
Si el fee es 0, corresponde a meses sin intereses. Si el fee es mayor a 0, significa que es pagos diferidos o meses con intereses. | |
|
|
amount |
Monto de la mensualidad. |
Float |
179.85 |
| |
|
|
total_amount |
Monto de la mensualidad más la comisión. |
Float |
539.55 |
| |
Código de ejemplo
Ejemplo de una llamada.
El siguiente bloque de código muestra un ejemplo de la solicitud cURL:
curl --location --request GET 'https://api.payclip.com/payment_methods/installments?amount=50000&bin=547046' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json'
El BIN debe ser de 6 ú 8 dígitos
Ejemplo de un objeto de la respuesta
El siguiente objeto es una respuesta de éxito con código HTTP 200 OK:
[
{
"payment_method_id": "visa",
"type": "credit_card",
"issuer": {
"default": false,
"name": "Banco Santander",
"country": "MX"
},
"validations": [
{
"name": "bin",
"metadata": {
"pattern": "^(4)",
"installment_pattern": "^(417401)"
}
},
{
"name": "card_number",
"metadata": {
"algorithm": "luhn",
"length": 16
}
},
{
"name": "cvv",
"metadata": {
"card_location": "back",
"length": 3,
"type": "mandatory"
}
},
{
"name": "accepted_amount",
"metadata": {
"min": 1,
"max": 300000
}
}
],
"installments": [
{
"quantity": 1,
"fee": 0,
"amount": 500,
"total_amount": 500
},
{
"quantity": 3,
"fee": 7.91,
"amount": 179.85,
"total_amount": 539.55
},
{
"quantity": 6,
"fee": 12.33,
"amount": 93.61,
"total_amount": 561.65
},
{
"quantity": 9,
"fee": 16.84,
"amount": 64.91,
"total_amount": 584.2
}
],
"tags": [
"product:COSTCO CITIBANAMEX"
]
}
]
Códigos de respuesta
La siguiente tabla contiene una lista de los códigos de respuesta y su asociación con algunos de los estados HTTP:
|
404 |
BR1301 |
Not Found |
|
|
401 |
CL1501 |
Unauthorized |
|
|
500 |
AI1899 |
Internal error. |
|
Este es un ejemplo del objeto de error en formato JSON:
{
"error_code": "BR1301",
"message": "Not found",
"detail": [
"payment not found"
]
}
Llamada de prueba
Puedes realizar una llamada de prueba, únicamente asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en el botón "Try It!":
