PAN

Endpoints do serviço ws-hop-api-pan

PayShield Pan Service

post

Generate a Random PIN Returns the new PIN encrypted under the LMK in retMultiValue[0] with retCode 0 and retDescription Ok. In case of error returns the Error fields (retCode and RetDescription):

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 42

panstring · min: 12 · max: 19Required

PAN do cartão (12 a 19 dígitos)

Example: 1111222233334444

pinLengthinteger · min: 4 · max: 12Required

Comprimento do PIN a ser gerado (4 a 12 dígitos)

Example: 4

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestring · nullableOptional

Valor de retorno simples

retDescriptionstringOptional

Descrição do resultado

Example: No error

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

500

Erro interno do servidor

application/json

post/v4/PayShieldPan/GeneratePin

POST /v4/PayShieldPan/GeneratePin HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "client_id": 99,
  "pan": "1111222233334444",
  "pinLength": 4
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "M1F5A7C1B7B3F1FA15466A9B652A48270"
  ]
}

Translate Pan

post

Returns the account number for a PIN encrypted under LMK 02-03 from an old account number to a new account number in retMultiValue[0] with retCode 0 and retDescription OK. In case of error, it returns details in the Error fields (retCode and RetDescription).

The customer PIN itself remains unchanged.

When using an AES Key Block LMK, the LMK-encrypted PIN is the result of encrypting the PIN under the LMK using Thales PIN Block format 48 (ISO PIN Block format 4).

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 42

pinstring · max: 33Required

PIN criptografado sob a LMK

Example: M1F5A7C1B7B3FC5B15466A9B652A48270

oldPanstring · min: 12 · max: 19Required

PAN antigo do cartão (12 a 19 dígitos)

Example: 1111222233334444

newPanstring · min: 12 · max: 19Required

Novo PAN do cartão (12 a 19 dígitos)

Example: 4444333322221111

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestring · nullableOptional

Valor de retorno simples

retDescriptionstringOptional

Descrição do resultado

Example: No error

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

500

Erro interno do servidor

application/json

post/v4/PayShieldPan/TranslatePan

POST /v4/PayShieldPan/TranslatePan HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "client_ID": 99,
  "pin": "M1F5A7C1B7B3F1FA15466A9B652A48270",
  "oldPan": "1111222233334444",
  "newPan": "4444333322221111"
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "MB3F1F1FAC1B7C5B15466A9B652B48270"
  ]
}

Translate PIN LMK (AES) To ZPK (AES)

post

Translate PIN LMK (AES) To ZPK (AES)

Returns the translated PIN from encryption under the LMK (AES) to encryption under a ZPK (AES) in retMultiValue[0] with retCode 0 and retDescription OK. In case of error, it returns details in the Error fields (retCode and RetDescription)

When used with a Variant LMK or 3DES Key Block LMK, the PIN encrypted under the LMK will always be using a non-ISO format

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 42

keyIdstringRequired

Alias/identificador da chave ZPK de destino

Example: client-42-key-id-020-ZPK-AES-A3

pinstring · max: 33Required

PIN criptografado sob a LMK

Example: MABCDEF0123456789ABCDEF0123456789

panstringRequired

PAN do cartão

Example: 1111222233334444

formatCodeinteger · max: 4Required

Código de formato do PinBlock de destino:

0 → formato Thales 01
1 → formato Thales 05
3 → formato Thales 47
4 (padrão) → formato Thales 48

Example: 4

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestring · nullableOptional

Valor de retorno simples

retDescriptionstringOptional

Descrição do resultado

Example: No error

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

500

Erro interno do servidor

application/json

post/v4/PayShieldPan/TranslatePinLmkToZpk

POST /v4/PayShieldPan/TranslatePinLmkToZpk HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-ZPK-AES-A3",
  "pin": "MABCDEF0123456789ABCDEF0123456789",
  "pan": "1111222233334444",
  "formatCode": 4
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "7B263B49A188AB9C30ECF07862F1FA08"
  ]
}

Translate PIN ZPK (AES) to LMK (AES)

post

Returns the translated PIN from encryption under the ZPK (AES) to encryption under a LMK (AES) in retMultiValue[0] with retCode 0 and retDescription Ok. In case of error, it returns details in the Error fields (retCode and RetDescription)

When used with a Variant LMK or 3DES Key Block LMK, the PIN encrypted under the LMK will always be using a non-ISO format

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 42

keyIdstringRequired

Alias/identificador da chave ZPK de origem

Example: client-42-key-id-020-ZPK-AES-A3

pinstring · min: 16 · max: 16Required

PinBlock criptografado sob a ZPK (exatamente 16 dígitos)

Example: 7B263B49A188AB9C30ECF07862F86008

panstring · min: 16 · max: 16Required

PAN do cartão (exatamente 16 dígitos)

Example: 1111222233334444

formatCodeinteger · max: 4Required

Código de formato do PinBlock de origem:

0 → formato Thales 01
1 → formato Thales 05
3 → formato Thales 47
4 (padrão) → formato Thales 48

Example: 4

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestring · nullableOptional

Valor de retorno simples

retDescriptionstringOptional

Descrição do resultado

Example: No error

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

500

Erro interno do servidor

application/json

post/v4/PayShieldPan/TranslatePinZpkToLmk

POST /v4/PayShieldPan/TranslatePinZpkToLmk HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-ZPK-AES-A3",
  "pin": "7B263B49A188AB9C30ECF1FA62F86008",
  "pan": "1111222233334444",
  "formatCode": 4
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "MABCDEF0123456789ABCDEF0123456789"
  ]
}

PreviousPIN NextCVV

Last updated 1 month ago