# Get payment prediction

Prediction about the outcome of a payment, whether it will succeed or not. Additional information such as maximum possible transfer to a new recipient.

Endpoint: GET /v3/predict
Version: v3.0
Security: Api-Key

## Query parameters:

  - `payer_email` (string, required)
    Email of the payer

  - `bank_id` (string, required)
    Identifier of the originating bank

  - `amount` (string, required)
    Payment amount

  - `currency` (string, required)
    Currency in ISO-4217 format

## Response 200 fields (application/json):

  - `new_destinatary_max_amount` (number, required)
    Maximum amount to transfer to a new recipient.
    Example: 100000

  - `max_amount` (number, required)
    The maximum possible amount to transfer.
    Example: 5000000

  - `result` (string, required)
    The result of the prediction.
    Enum: "ok", "new_destinatary_amount_exceeded", "max_amount_exceeded", "new_destinatary_cool_down", "not_available_account"

  - `cool_down_date` (string, required)
    End date for the amount restriction in ISO-8601 format.
    Example: "2024-06-21T11:23:09.123Z"