PIN

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

Validar PIN

post

Returns the OK(true) / Not Ok (false) in (retValid), in case of error returns the Error fields (retCode and RetDescription).

Authorizations

bearerAuth

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

application/json

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 99

keyIdstringRequired

Alias/identificador da chave TPK ou ZPK no banco de dados

Example: client-99-key-id-XXXXX-TPK

hPinBlockstringRequired

PinBlock em formato Hexadecimal

Example: 65CDF8DA33954DA41CF1FAAD68AA75AB

pinBlockFmtstringRequired

Formato do PinBlock. Valores válidos: 01, 02, 03, 04, 05, 34, 35, 41, 42, 47, 48

Example: 48

hPinHoststring · nullableOptional

PIN Host em formato Hexadecimal (usado para validação contra PIN armazenado)

Example: MFA7DB4D986A8238EF1FA11A584459157

panstringRequired

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

Example: 1111222233334444

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

retValuestringOptional

Valor de retorno simples

Example: PIN Validated

retDescriptionstringOptional

Descrição do resultado

Example: OK

retMultiValueany · nullableOptional

400

Requisição inválida — campo obrigatório ausente ou formato incorreto

application/json

401

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

404

Chave não encontrada no banco de dados

application/json

500

Erro interno do servidor

application/json

post/v4/PayShieldPin/ValidatePin

HTTPcURLJavaScriptPython

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

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-TPK",
  "hPinBlock": "65CDF8DA33954DA41CF1FAAD68AA75AB",
  "pinBlockFmt": "48",
  "hPinHost": "MFA7DB4D986A8238EF1FA11A584459157",
  "pan": "1111222233334444"
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "PIN Validated",
  "retDescription": "OK",
  "retMultiValue": null
}

Traduzir PIN

post

Returns the PibBlock protected by the KeyIdDst key (in retMultiValue), in case of error it returns the Error fields (retCode and RetDescription).

Authorizations

bearerAuth

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

application/json

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 99

keyIdSrcstringRequired

Alias/identificador da chave de origem (TPK, ZPK ou BDK)

Example: client-99-key-id-XXXXX-BDK

hPinBlockSrcstringRequired

PinBlock de origem em formato alfanumérico (a-z, A-Z, 0-9)

Example: DD147680BAF1FA43

pinBlockFmtSrcstringRequired

Formato do PinBlock de origem. Valores válidos: 01, 02, 03, 04, 05, 34, 35, 41, 42, 47, 48

Example: 01

hPinHoststring · nullableOptional

PIN Host em formato Hexadecimal (opcional)

keyIdDststringRequired

Alias/identificador da chave de destino (TPK, ZPK ou BDK)

Example: client-99-key-id-XXXXX-ZPK

pinBlockFmtDststringRequired

Formato do PinBlock de destino. Valores válidos: 01, 02, 03, 04, 05, 34, 35, 41, 42, 47, 48

Example: 01

panstringRequired

PAN do cartão de origem (16 a 19 dígitos)

Example: 1234000001234864

ksn_descstring · nullableOptional

Descritor KSN da chave de origem — necessário apenas se keyIdSrc for do tipo BDK (DUKPT)

Example: 505

ksnstring · nullableOptional

KSN da chave de origem — necessário apenas se keyIdSrc for do tipo BDK (DUKPT)

Example: 98765876543210E20004

pan_dststring · nullableOptional

PAN do cartão de destino (16 a 19 dígitos) — necessário quando o PAN de destino difere do de origem

ksn_desc_dststring · nullableOptional

Descritor KSN da chave de destino — necessário apenas se keyIdDst for do tipo BDK (DUKPT)

ksn_dststring · nullableOptional

KSN da chave de destino — necessário apenas se keyIdDst for do tipo BDK (DUKPT)

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

retValuestringOptional

Valor de retorno simples (geralmente vazio em sucesso)

retDescriptionstringOptional

Descrição do resultado

Example: OK

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação TranslatePin:

• [0] = PINLength (ex: "04")
• [1] = destPINBlock (ex: "AFA6E4F1FA93CB9F")
• [2] = destPBFormat (ex: "01")

Example: ["04","AFA6E4F1FA93CB9F","01"]

400

Requisição inválida — campo obrigatório ausente ou formato incorreto

application/json

401

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

404

Chave não encontrada no banco de dados

application/json

500

Erro interno do servidor

application/json

post/v4/PayShieldPin/TranslatePin

HTTPcURLJavaScriptPython

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

{
  "client_id": 99,
  "keyIdSrc": "client-99-key-id-XXXXX-BDK",
  "hPinBlockSrc": "DD147680BAF1FA43",
  "pinBlockFmtSrc": "01",
  "keyIdDst": "client-99-key-id-XXXXX-ZPK",
  "pinBlockFmtDst": "01",
  "pan": "1234000001234864",
  "ksn_desc": "505",
  "ksn": "98765876543210E20004",
  "pan_dst": null,
  "ksn_desc_dst": null,
  "ksn_dst": null
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "04",
    "AFA6E4F1FA93CB9F",
    "01"
  ]
}