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.

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

Email of the payer

bank_id
required
string <= 255 characters

Identifier of the originating bank

amount
required
string <= 255 characters

Payment amount

currency
required
string <= 255 characters

Currency in ISO-4217 format

Responses
200

Successful operation. Returns a JSON object with the prediction along with additional information.

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

Maximum amount to transfer to a new recipient.

Example: 100000
max_amount
required
number <double>

The maximum possible amount to transfer.

Example: 5000000
result
required
string

The result of the prediction.

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

End date for the amount restriction in ISO-8601 format.

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

Bad request

401

Unauthorized - Invalid or missing credentials

403

Forbidden

404

Not found - Resource not available

500

Internal server error

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
}