PAR Lookup

Looks up the Payment Account Reference (PAR) for a card number or network token. A PAR is a stable identifier assigned by the card network that stays constant across card reissues, renewals, and replacements, and is shared by every network token derived from the card.

post/payments/par-lookups

Request

Base URL
https://api.evervault.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/evervault/apis/evervault-api/docs/payments/par-lookups/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

numberstring required

The card number (FPAN) or network token number (DPAN) for which the PAR is being requested. It can be a plaintext or an Evervault-encrypted number, and must be 12-19 digits and pass a Luhn check.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns the PAR resolved for the provided card number or network token.

idstring required

The unique identifier for the PAR lookup

paymentAccountReferencestring required

The Payment Account Reference (PAR) for the supplied card. This is a stable identifier assigned by the card network that stays constant across card reissues, renewals, and replacements, and is shared by every network token derived from the card.

Example response

{
  "id": "par_lookup_1234567890",
  "paymentAccountReference": "5001BN2CUZCOY2H2IJILTJJZWTEPW"
}

Changes

No recorded changes to this operation across all 1 revision of this API.