v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

HST

Send pre-authentication for evaluation

Send pre authentication information to customer to evaluate the authentication.

post/customer_evaluation_provided_url

Headers

account_idinteger required

Account ID

card_idinteger required

Card ID

Request body

idstring required

Pismo-generated unique authentication ID

external_idstring required

Provider-generated unique ID for client monitoring and tracking

provider'HST' required

Third-party provider name

type'authentication' | 'challenge-request' required

Evaluation intention

raw_providerRawProvider required

All non-PCI information received from provider. Check provider documentation for details.

Example request

{
  "id": "ff77635e-1cd6-4fda-992d-5ceb71d75644",
  "external_id": "ABC123456",
  "provider": "HST",
  "type": "authentication",
  "card": {
    "id": 6743052,
    "mode_id": 102,
    "type": "PLASTIC",
    "hash": "WEPvOQuZvjfYEd0iBmr43bhWyOsylIsW95ebYrLD89App2iEq9IizP+8w73pxKQ4mI47EdhzYHF9RfXjrBOyug==",
    "bin": "885692",
    "last_four_digits": "0153"
  },
  "account": {
    "id": 6912345,
    "document_number": "7777888hh",
    "postal_code": "01701000"
  },
  "program": {
    "id": 986
  },
  "customer": {
    "id": 5648988
  }
}

Response

decision'approve' | 'reject' | 'request_challenge' required

Client's anti-fraud evaluated decision

subissuer_idstring

Client's subissuer override, we will use this one to override the issuerSpecificData.subissuerID, if empty, we will use the org_id value.

product_idstring

Client's product override, we will use this one to override the issuerSpecificData.productID, if empty, we will use the program_id value.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "decision": "approve",
  "challenge_info": {
    "cardholder_name": "John Doe",
    "method": "OTP",
    "cardholder_phone": {
      "country_code": "55",
      "area_code": "11",
      "number": "912345678"
    }
  },
  "subissuer_id": "ANOTHER_BANK",
  "product_id": "CREDIT",
  "metadata": "{ \"key\": \"value\"}"
}