v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Pre-authentication

Send pre-authentication info

Send pre-authentication information to the client's anti-fraud validator to evaluate. Pismo calls the validator's webhook and gets a response before sending a response to the caller.

Pismo provides the encrypt/decrypt keys for the hashed PAN. Talk to your Pismo representative about getting these keys.

For information on PAN encryption, refer to the PAN encryption for 3DS authentication guide.

post/v1/preauthenticate

Request body

idstring required

Client-generated caller ID.

panstring required

Encrypted PAN using 2048 rsa key and base64 encoded. Pismo provides the encrypt/decrypt keys for this field.

raw_providerRawProvider

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

Example request

{
  "id": "ff77635e-1cd6-4fda-992d-5ceb71d75644",
  "pan": "WEPvOQuZvjfYEd0iBmr43bhWyOsylIsW95ebYrLD89App2iEq9IizP+8w73pxKQ4mI47EdhzYHF9RfXjrBOyug=="
}

Response

idstring

The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header.

external_idstring

Provider-generated unique ID for client monitoring and tracking

decision'approve' | 'reject'

Client's anti-fraud decision

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

{
  "id": "c737895c-8159-4c0c-a92a-a4f8600bff37",
  "external_id": "ABC123456",
  "decision": "approve",
  "account": {
    "id": 6912345,
    "status": "NORMAL",
    "name": "Paul Bearer",
    "phone": "+5531998675309",
    "email": "ho_lee_smokes@gmail.com"
  },
  "customer": {
    "id": 5648988,
    "name": "Paul Bearer",
    "phone": "+5531998675309",
    "email": "ho_lee_smokes@gmail.com"
  },
  "card": {
    "id": 6743052,
    "status": "ACTIVE",
    "type": "PLASTIC",
    "hash": "WEPvOQuZvjfYEd0iBmr43bhWyOsylIsW95ebYrLD89App2iEq9IizP+8w73pxKQ4mI47EdhzYHF9RfXjrBOyug==",
    "printed_name": "Sarah Toga"
  },
  "metadata": "{ \"key\": \"value\"}"
}