Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Bank Predictions

Predict banks for a customer based on their contact information

Predict banks for a customer based on their contact information

post/api/v1/bank-predictions

Request body

merchant_idstring uuid

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

customer_countrystring required

ISO 3166-1 alpha-2 country code

phone_numberstring

Customer phone number in international format

emailstring email

Customer email address

payment_request_idstring uuid

Payment request ID for Shopify

session_idstring

Session ID for WooCommerce

Example request

{
  "merchant_id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_country": "GB",
  "phone_number": "+447395263205",
  "email": "customer@example.com",
  "payment_request_id": "123e4567-e89b-12d3-a456-426614174000",
  "session_id": "wca23456789abcdef"
}

Response

Success

successboolean required