Get payment prediction

Predicción acerca del resultado de un pago, si podrá o no funcionar. Información adicional como máximo posible de transferir a un nuevo destinatario.

SecurityApi-Key
Request
query Parameters
payer_email
required
string <= 255 characters

Correo electrónico del pagador

bank_id
required
string <= 255 characters

Identificador del banco de origen

amount
required
string <= 255 characters

Monto del pago

currency
required
string <= 255 characters

Moneda en formato ISO-4217

Responses
200

Operación exitosa. Devuelve un objeto JSON con la predicción junto con información adiciónal.

Response Schema: application/json
new_destinatary_max_amount
required
number <double>

Monto máximo para transferir a un nuevo destinatario.

Example: 100000
max_amount
required
number <double>

El monto máximo posible para transferir.

Example: 5000000
result
required
string

El resultado de la predicción.

Enum: "ok" "new_destinatary_amount_exceeded" "max_amount_exceeded" "new_destinatary_cool_down" "not_available_account"
Example: "ok"
cool_down_date
required
string

Fecha de término para la restricción de monto en formato ISO-8601

Example: "2024-06-21T11:23:09.123Z"
400

Bad request - Solicitud mal formada

401

Unauthorized - Credenciales no válidas o faltantes

403

Forbidden - Cliente no tiene privilegios

404

Not found - Recurso no disponible

500

Internal server error - Servidor no pudo completar la solicitud

get/v3/predict
Request samples 
Response samples 
application/json
{
  • "result": "ok",
  • "max_amount": 5000000,
  • "cool_down_date": "2024-06-21T11:23:09.123Z",
  • "new_destinatary_max_amount": 100000
}