Sign in
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

Changes

Changed in 3 of the 8 revisions of this API.424

  • b372e7d5563d323See the full diff
    • ▲

      the request property's minLength was increased from 0 to 2

      request-property-min-length-increased

    • ▲

      added the pattern ^[A-Za-z]{2}$ to the request property

      request-property-pattern-added

    • ▲

      the / response's property type changed from string to no type for status

      response-property-type-changed

    • ●

      the request property's maxLength was set to 2

      request-property-max-length-set

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added subschema #1 subschema #2 to the / response property allOf list for the response status

      response-property-all-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog