Crypto

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

Data Encryption Module

post

Returns encrypted data and IV (if applicable) (in retMultiValue), always in Hex format, in case of error, it returns details in the Error fields (retCode and RetDescription). Returns the following in retMultiValue: in retMultiValue:

retMultiValue[0] = msgRespEncrypted -> Encrypted message (open) retMultiValue[1] = ivResp - > IV for the next call to decrypt only in case of modeEncFlag 01, 02, 03, otherwise this field will be null

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 2

keyIdstringRequired

Alias/identificador da chave no banco de dados

Example: client-42-key-id-XXX-ZEK

modeEncFlagstringRequired

Modo de operação da cifra:

00: ECB (padrão se null ou valor não listado)
01: CBC (requer IV)
02: CFB8 (requer IV)
03: CFB64 (requer IV)

Example: 00

ksn_descstring · nullableOptional

Descritor KSN — necessário apenas se o keyId for do tipo BDK (DUKPT)

ksnstring · nullableOptional

KSN — necessário apenas se o keyId for do tipo BDK (DUKPT)

ivstring · nullableOptional

Vetor de inicialização em Hex — obrigatório nos modos 01, 02, 03

Example: 12345678123456781234567812345678

data_fmtstring · enumRequired

Formato dos dados de entrada:

H: Hexadecimal
T: Texto

Example: HPossible values:

p_ht_datastringRequired

Dados a serem criptografados em formato H (Hex) ou T (Texto)

Example: 1407C97819537CE2...

b_datastring · nullableOptional

Dados em formato binário (uso reservado)

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

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

Example: 0

retValuestringOptional

Valor de retorno simples (geralmente vazio em sucesso)

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retDescriptionstringOptional

Descrição do resultado

Example: OK

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/PayShieldCrypto/EncryptData

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

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-ZEK",
  "modeEncFlag": "01",
  "ksn_desc": null,
  "ksn": null,
  "iv": "12345678123456781234567812345678",
  "data_fmt": "H",
  "p_ht_data": "01C01407C97859537CE2E58D0D9AE808E39ADE20ACA2D371E469EE40D27D4F65281EF52C8D8725ADE119FDC47600E1C917F6F9EDDF2100554A007128DF9453325C6FE0FDA56F29C23E6642928480ACDFF08CC705ED3A99E48467839C038529C49C70EA16395E3EDF400934A1D0260D6FD4FD5D3A411479837481CC07DE244C853D40F3620150D462138D3A82AE63DA9A31FC717EDC4DDA1FE5A5CE415534D9FC968F8DD9A9CAADDA5953969AE581CF855D8844F983F270A9DA9331644282F607324DF48DD8227A71E2E374CF7AC6908268145D785D59ED548617606C0A6AD69A",
  "b_data": null
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "",
  "retDescription": "OK",
  "retMultiValue": [
    "1407C97819537CE2E58D0D9AE808E39ADE20ACA2D371E469EE40D27D4F65281EF52C8D8725ADE119FDC47600E1C917F6F9EDDF2100554A007128DF9453325C6FE0FDA56F29C23E6642928480ACDFF08CC705ED3A99E48467839C038529C49C70EA16395E3EDF400934A1D0260D6FD4FD5D3A411479837481CC07DE244C853D40F3620150D462138D3A82AE63DA9A31FC717EDC4DDA1FE5A5CE415534D9FC968F8DD9A9CAADDA5953969AE581CF855D8844F983F270A9DA9331644282F607324DF48DD8227A71E2E374CF7AC6908268145D785D59ED548617606C0A6AD69A078F",
    null
  ]
}

Data Decryption Module

post

Returns decrypted data and IV (if applicable) (retMultiValue), always in Hex format, in case of error, it returns details in the Error fields (retCode and RetDescription). Returns the following in retMultiValue: Returns the following in retMultiValue:

retMultiValue[0] = msgRespDecrypted -> Decrypted message (open) retMultiValue[1] = ivResp - > IV for the next call to encrypt only in case of modeEncFlag 01, 02, 03, otherwise this field will be null

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 2

keyIdstringRequired

Alias/identificador da chave no banco de dados

Example: client-42-key-id-XXX-ZEK

modeEncFlagstringRequired

Modo de operação da cifra:

00: ECB (padrão se null ou valor não listado)
01: CBC (requer IV)
02: CFB8 (requer IV)
03: CFB64 (requer IV)

Example: 00

ksn_descstring · nullableOptional

Descritor KSN — necessário apenas se o keyId for do tipo BDK (DUKPT)

ksnstring · nullableOptional

KSN — necessário apenas se o keyId for do tipo BDK (DUKPT)

ivstring · nullableOptional

Vetor de inicialização em Hex — obrigatório nos modos 01, 02, 03

Example: 12345678123456781234567812345678

data_fmtstring · enumRequired

Formato dos dados de entrada:

H: Hexadecimal
T: Texto

Example: HPossible values:

p_h_datastringRequired

Dados criptografados a serem descriptografados em formato Hex

Example: 1407C97819537CE2...

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

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

Example: 0

retValuestringOptional

Valor de retorno simples (geralmente vazio em sucesso)

retMultiValuestring[] · nullableOptional

Array com os valores de retorno da operação

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retDescriptionstringOptional

Descrição do resultado

Example: OK

400

Formato de data_fmt inválido — use 'H' (Hexadecimal) ou 'T' (Texto)

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/PayShieldCrypto/DecryptData

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

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-ZEK",
  "modeEncFlag": "01",
  "ksn_desc": null,
  "ksn": null,
  "iv": "12345678123456781234567812345678",
  "data_fmt": "H",
  "p_h_data": "1407C97819537CE2E58D0D9AE808E39ADE20ACA2D371E469EE40D27D4F65281EF52C8D8725ADE119FDC47600E1C917F6F9EDDF2100554A007128DF9453325C6FE0FDA56F29C23E6642928480ACDFF08CC705ED3A99E48467839C038529C49C70EA16395E3EDF400934A1D0260D6FD4FD5D3A411479837481CC07DE244C853D40F3620150D462138D3A82AE63DA9A31FC717EDC4DDA1FE5A5CE415534D9FC968F8DD9A9CAADDA5953969AE581CF855D8844F983F270A9DA9331644282F607324DF48DD8227A71E2E374CF7AC6908268145D785D59ED548617606C0A6AD69A078F"
}

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

PreviousHoP V4 - Documentação endpoints NextPIN

Last updated 2 months ago