RDX 2.2.3 YAML File
Este documento fornece um formato de arquivo de fácil uso e visualizaç ão para implementar as chamadas e respostas para as APIs do VCAS RDX, incluindo Risk, Stepup, InitateAction e Validate.
openapi: 3.0.1
info:
title: VCAS Real-Time Data Exchange (RDX) API
description: "Este documento fornece um formato de arquivo de fácil uso e visualizaç\
ão para implementar as chamadas e respostas para as APIs do VCAS RDX, incluindo\
\ Risk, Stepup, InitateAction e Validate. Para obter melhores resultados, este\
\ arquivo deve ser visualizado usando Swagger ou ferramenta semelhante para renderizar\
\ o arquivo yaml. Este documento foi projetado para ser usado em conjunto com\
\ a especificação VCAS Real-Time Data Exchange."
contact:
name: CardinalCommerce
url: http://www.cardinalcommerce.com
version: 2.2.3 - Portuguese
x-readme:
proxy-enabled: false
paths:
/risk:
post:
tags:
- RDX Requests
summary: Risk Request
description: "A chamada de Risk é a primeira etapa do processo RDX e correlaciona\
\ informações da transação, comerciante, consumidor e dispositivo para determinar\
\ o nível de risco em uma determinada transação."
operationId: risk
requestBody:
description: Risk Request Object
content:
application/json:
schema:
$ref: '#/components/schemas/RiskRequest'
required: true
responses:
"200":
description: Successful Risk Response
content:
application/json:
schema:
$ref: '#/components/schemas/RiskResponse'
"405":
description: Invalid input
content: {}
x-codegen-request-body-name: body
/stepup:
post:
tags:
- RDX Requests
summary: Stepup Request, Biometric
description: A Stepup Request is communicated by the VCAS platform to the partner. The partner responds with parameters necessary for VCAS to perform the step-up challenge.
operationId: stepup-biometric
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StepupRequest'
description: Stepup Request Object
required: true
responses:
'200':
description: Successful Stepup Response
content:
application/json:
schema:
$ref: '#/components/schemas/StepupResponse'
'405':
description: Invalid input
/initiateaction:
post:
tags:
- RDX Requests
summary: Initiate Action Request
description: A chamada de Initiate Action é usada para sinalizar ao cliente
para executar uma ação em um ponto do fluxo.
operationId: initiateaction
requestBody:
description: InitiateAction Request Object
content:
application/json:
schema:
$ref: '#/components/schemas/InitiateActionRequest'
required: true
responses:
"200":
description: Successful Initiate Action Response
content:
application/json:
schema:
$ref: '#/components/schemas/InitiateActionResponse'
"405":
description: Invalid input
content: {}
x-codegen-request-body-name: body
/validate:
post:
tags:
- RDX Requests
summary: Validate Request
description: "A chamada de Validate é comunicada pela plataforma VCAS ao cliente.\
\ O cliente pode responder com lógica de Success (Sucesso), Failure (Falha)\
\ ou Retry (Nova tentativa)."
operationId: validate
requestBody:
description: Stepup Validation Request Object
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateRequest'
required: true
responses:
"200":
description: Successful Validate Response
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateResponse'
"405":
description: Invalid input
content: {}
x-codegen-request-body-name: body
components:
schemas:
MerchantInfo:
required:
- MerchantURL
type: object
properties:
AcquirerId:
type: string
description: AcquirerId para o comerciante que realiza a solicitação de
compra. Até 11 caracteres.
default: "1337"
AcquirerCountryCode:
type: string
description: "Código do país do adquirente. Formato numérico ISO 3166-1.\
\ Os emissores precisam de estar cientes do código do país adquirente\
\ quando o país adquirente for diferente do país do estabelecimento e\
\ o adquirente estiver no EEE (isto pode significar que a transação está\
\ dentro do Espaço Econômico Europeu. Nota: Atualmente disponível apenas\
\ no EMV 3DS para transações Visa e Mastercard e 3DS 1.0 Visa quando os\
\ dados estão presentes e com o indice PSD2 ativado."
default: "840"
MerchantId:
type: string
description: ID do comerciante que realiza a solicitação de compra.
default: "876543210"
MerchantName:
type: string
description: Nome do comerciante que realiza a solicitação de compra. Até
40 caracteres.
default: Ranier Expeditions
MerchantURL:
type: string
description: URL ou nome do aplicativo do comerciante que realiza a solicitação
de compra. Até 2048 caracteres.
default: https://www.requestor.com
MerchantCategoryCode:
type: string
description: Código usado para descrever o tipo de produto ou serviço comercial
do comerciante específico da rede de pagamento. Consulte cada rede de
pagamento para obter mais detalhes.
default: "0123"
MerchantCountryCode:
type: string
description: Código do país do comerciante; para transações EMV 3DS esse
valor é de 3 caracteres; por exemplo. 840
default: "840"
MerchantAppRedirectURLInfo:
required:
- MerchantURL
type: object
properties:
AcquirerId:
type: string
description: AcquirerId para o comerciante que realiza a solicitação de
compra. Até 11 caracteres.
default: "1337"
AcquirerCountryCode:
type: string
description: "Código do país do adquirente. Formato numérico ISO 3166-1.\
\ Os emissores precisam de estar cientes do código do país adquirente\
\ quando o país adquirente for diferente do país do estabelecimento e\
\ o adquirente estiver no EEE (isto pode significar que a transação está\
\ dentro do Espaço Econômico Europeu. Nota: Atualmente disponível apenas\
\ no EMV 3DS para transações Visa e Mastercard e 3DS 1.0 Visa quando os\
\ dados estão presentes e com o indice PSD2 ativado."
default: "840"
MerchantId:
type: string
description: ID do comerciante que realiza a solicitação de compra.
default: "876543210"
MerchantName:
type: string
description: Nome do comerciante que realiza a solicitação de compra. Até
40 caracteres.
default: Ranier Expeditions
MerchantURL:
type: string
description: URL ou nome do aplicativo do comerciante que realiza a solicitação
de compra. Até 2048 caracteres.
default: https://www.requestor.com
MerchantCategoryCode:
type: string
description: Código usado para descrever o tipo de produto ou serviço comercial
do comerciante específico da rede de pagamento. Consulte cada rede de
pagamento para obter mais detalhes.
default: "0123"
MerchantCountryCode:
type: string
description: Código do país do comerciante; para transações EMV 3DS esse
valor é de 3 caracteres; por exemplo 840
default: "840"
MerchantAppRedirectURL:
type: string
description: "Merchant app declaring their URL within the CReq message so\
\ that the Authentication app can call the Merchant app after OOB authentication\
\ has occurred. Each transaction requires a unique Transaction ID by using\
\ the SDK Transaction ID. VCAS will validate the value to ensure it contains\
\ a scheme which will route the authentication app to the associated merchant\
\ app. Exemplo: merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067"
default: merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067
PaymentInfo:
required:
- CardExpiryMonth
- CardExpiryYear
- CardNumber
type: object
properties:
CardNumber:
type: string
description: Número do cartão de pagamento utilizado na transação. 13 -
19 caracteres.
default: "4012009500714811"
CardExpiryMonth:
type: string
description: Mês de validade.
default: "08"
CardExpiryYear:
type: string
description: "Ano de validade: 2 ou 4 dígitos; por exemplo: 28 ou 2028."
default: "28"
CardType:
type: string
description: "Tipo de cartão ou conta, por ex. Débito ou Crédito. Nota:\
\ Este campo é específico para extensões do Mercado Brasileiro devido\
\ ao cartões combo."
enum:
- Credit
- Debit
- NotApplicable
CardHolderName:
type: string
description: Nome do titular do cartão. Até 45 caracteres.
default: Santiago Rodrigues
Address:
required:
- FirstName
- LastName
type: object
properties:
FirstName:
type: string
description: Primeiro nome do morador do endereço.
MiddleName:
type: string
description: Nome do meio para o morador do endereço.
LastName:
type: string
description: Último nome para o morador do endereço.
Address1:
type: string
description: Linha 1 do endereço.
Address2:
type: string
description: Linha 2 do endereço.
Address3:
type: string
description: Linha 3 do endereço.
Locality:
type: string
description: Cidade
Region:
type: string
description: "Estado, Província, Território, etc."
PostalCode:
type: string
description: Código Postal.
CountryCode:
type: string
description: O código do país seguirá o formato ISO 3166-1; Numérico de
3 dígitos.
CartItem:
type: object
properties:
Name:
type: string
description: Nome do item no carrinho de compras. Até 50 caracteres.
SKU:
type: string
description: SKU do produto. Até 50 caracteres.
Price:
type: string
description: Preço do item. Até 48 caracteres.
Quantity:
type: string
description: Quantidade de itens no carrinho. 2 caracteres.
ConsumerContact:
type: object
properties:
EmailAddress:
type: string
description: Endereço de e-mail do consumidor. Até 254 caracteres.
format: email
PhoneNumber:
type: string
description: Número de telefone do consumidor. O formato seguirá o padrão
E.164. Até 15 caracteres.
MobileNumber:
type: string
description: Número de celular do consumidor. O formato seguirá o padrão
E.164. Até 15 caracteres.
WorkNumber:
type: string
description: Número de trabalho do consumidor. O formato seguirá o padrão
E.164. Até 15 caracteres.
WalletInfo:
type: object
properties:
Provider:
type: string
description: Nome do provedor de carteira. Até 100 caracteres.
WalletAge:
maximum: 10000
minimum: 0
type: number
description: Número de dias desde que a carteira foi criada. Até 1000 caracteres.
format: Int64
PaymentCardAge:
maximum: 10000
minimum: 0
type: number
description: Número de dias que o cartão está na carteira. Até 1000 caracteres.
format: Int64
MerchantAdditionalData:
type: object
properties:
ShippingIndicator:
type: string
description: Indica a forma de envio escolhida para a transação.
enum:
- ShipToBillingAddress
- ShipToVerifiedAddress
- ShipToOtherAddress
- ShipToStore
- DigitalGoods
- TravelOrEventTickets
- Other
DeliveryTimeFrame:
type: string
description: Prazo de entrega.
enum:
- ElectronicDelivery
- SameDayShipping
- OvernightShipping
- TwoOrMoreDaysShipping
DeliveryEmailAddress:
type: string
description: Endereço de e-mail onde a mercadoria foi entregue. Até 254
caracteres.
ReorderItemsIndicator:
type: string
description: Indica se o titular do cartão fez o pedido anteriormente.
enum:
- FirstTime
- Reordered
PreorderPurchaseIndicator:
type: string
description: Indica compra com disponibilidade futura.
enum:
- MerchandiseAvailable
- FutureAvailability
PreorderDate:
type: string
description: A mercadoria com data prevista está disponível. Formato - AAAAMMDD.
Até 8 caracteres.
GiftCardAmount:
type: number
description: "Para um cartão-presente, este é o valor da compra (representado\
\ no valor bruto, por exemplo, 1000 por US$ 10,00). Até 15 caracteres."
GiftCardCurrency:
type: string
description: "ISO 4217; Padrão numérico de 3 dígitos. [ISO 4217 Link] https://en.wikipedia.org/wiki/ISO_4217\
\ Até 3 caracteres."
GiftCardCount:
type: number
description: Contagem total de cartões/códigos pré-pagos ou de presente
individuais adquiridos. Até 2 caracteres.
Device:
type: object
properties:
UserAgent:
type: string
description: Agente de usuário para navegador ou identificador de dispositivo
para compra InApp. Até 2048 caracteres.
IP:
type: string
description: Endereço IP do dispositivo. Até 45 caracteres.
Latitude:
type: string
description: Latitude do dispositivo com base na geolocalização ou endereço
IP. Até 50 caracteres.
Longitude:
type: string
description: Longitude do dispositivo com base na geolocalização ou endereço
IP. Até 50 caracteres.
BrowserAcceptHeader:
type: string
description: Cabeçalho de aceitação HTTP diretamente do navegador. Até 2048
caracteres.
BrowserJavaEnabled:
type: string
description: "Indica se o navegador pode executar Java. Exemplo, true. Até\
\ 5 caracteres."
BrowserJavascriptEnabled:
type: string
description: "Indica se o navegador pode executar javascript. Exemplo, true.\
\ Até 5 caracteres."
BrowserLanguage:
type: string
description: Idioma do navegador proporcionado pelas configuraçoes de propriedade
de idioma do navegador. Até 8 caracteres.
BrowserColorDepth:
type: string
description: Valor que representa a profundidade de bits da paleta de cores.
Até 2 caracteres.
BrowserScreenHeight:
type: string
description: Altura da tela do titular do cartão em pixels. Até 6 caracteres.
BrowserWidth:
type: string
description: Largura da tela do titular do cartão em pixels. Até 6 caracteres.
BrowserTimeZone:
type: string
description: "Diferença horária entre o horário UTC e o horário local do\
\ navegador do titular do cartão, em minutos. Até 5 caracteres."
IPCountry:
type: string
description: País de origem do endereço IP. Disponível somente em transações
iniciadas pelo navegador quando o URL do método for concluído com êxito;
o Até varia.
Platform:
type: string
description: "Plataforma do dispositivo. Exemplo, Android, iOS. Até 30 caracteres."
DeviceModel:
type: string
description: Fabricante e modelo do dispositivo móvel. Até 25 caracteres.
OperatingSystemName:
type: string
description: Nome do sistema operacional do dispositivo. Até 50 caracteres.
OperatingSystemVersion:
type: string
description: Versão do sistema operacional do dispositivo. Até 25 caracteres.
Locale:
type: string
description: "Localidade do dispositivo no cabeçalho do navegador ou nas\
\ configurações de idioma do aplicativo. Esse valor pode ser um único\
\ valor de localidade ou vários valores concatenados com vírgulas. No\
\ EMV 3DS isso não está disponível devido a novos fluxos, portanto este\
\ será um valor de idioma único seguindo o formato BCP 47; e.g. en-US\
\ or en,es-PE;q=0.9,es;q=0.8"
AdvertisingId:
type: string
description: ID exclusivo disponível para fins de publicidade e detecção
de fraude no aplicativo nativo do comerciante. Até 128 caracteres.
ScreenResolution:
type: string
description: "Largura e altura do pixel. Exemplo, 1080x1920 Até 15 caracteres."
DeviceName:
type: string
description: Nome do dispositivo atribuído pelo usuário.Até 50 caracteres.
SDKAppId:
type: string
description: ID universalmente exclusivo criado em todas as instalações
e atualizações do aplicativo solicitante 3DS para o dispositivo do consumidor.
Até 36 caracteres.
DeviceExtendedData:
type: string
description: Objeto JSON codificado em Base64url. Informações do dispositivo
coletadas pelo 3DS SDK de um dispositivo de consumidor. Até 64000 caracteres'
RiskProvider:
type: object
properties:
Name:
type: string
description: Provedor de perfil de dispositivo e mecanismo de risco.
enum:
- TM
- Payfone
- Cardinal
ProviderId:
type: string
description: ID de referência da transação do Provedor de Risco. Até 100
caracteres.
DeviceId:
type: string
description: "DeviceId pode ser usado para identificar comportamentos de\
\ risco ou normais do titular do cartão. O ID é o ID da sessão de transaç\
ão fornecido pelo servidor 3DS. Os dados do DeviceId dependem da coleta\
\ de dados do URL do método, apenas para transações baseadas em navegador\
\ EMV 3DS. Até 100 caracteres."
DAFExtension :
type: object
properties:
AuthPayCredStatus:
type: string
description: Enables the communication of Authenticated Payment Credential Status between the VDS and the 3DS Server, and the VDS and the ACS. (Y, N, U, B, I). One caracter.
default: 'Y'
AuthPayProcessReqInd:
type: string
description: Indicates whether the purpose of the transaction is to process as a DAF transaction or to inquire on the Authenticated Payment Credential Status. 2 caracteres.
default: '01'
DafAdvice:
type: string
description: Indicates to ACS whether the transaction must be approved or whether approval is an issuer decision. (01 = must approve; 02 = issuer decision). 2 caracteres.
default: '01'
Version:
type: string
description: Version number of the message extension being used; ex. 1.0. Up to 5 caracteres.
default: '1.0'
RiskRequestTransactionInfo:
type: object
properties:
TransactionTimeStamp:
type: string
description: Data e hora da transação em UTC de acordo com ISO 8601 UTC;
por exemplo. 21-03-2024T20:55:49.000Z
format: date-time
TransactionAmount:
type: number
description: "Valor da transação (valor bruto, exemplo 1000 por US$ 10,00).\
\ Até 48 caracteres."
format: decimal
TransactionAmountUSD:
type: number
description: "Valor da transação em USD (valor bruto, exemplo 1000 por US$ 10,00).\
\ Até 48 caracteres."
format: decimal
TransactionCurrency:
type: string
description: "ISO 4217; Padrão numérico de 3 dígitos. Referência: [ISO 4217\
\ Link] https://en.wikipedia.org/wiki/ISO_4217 Até 3 caracteres."
default: "840"
TransactionExponent:
type: integer
description: Expoente para formatar o código ISO 4217 da moeda fornecida.
Até um caracter.
TransactionType:
type: string
description: Tipo da transação.
enum:
- Purchase
- CardAdd
MandatedRegion:
type: string
description: "Um valor que descreve a região na qual a regulamentação pode\
\ ser aplicados à transação atual. Adicionado para suportar as novas transaç\
ões PSD2 no EEA. Nota: Este valor não estará presente a menos que o emissor\
\ trabalhe com seu gerenciador de integração para ativar os recursos do\
\ PSD2. Nota: Deve-se levar em conta novos valores adicionados a este\
\ campo ao longo do tempo devido a novas regulamentações implementadas\
\ em outras regiões."
enum:
- EEA
- NONE
- UNKNOWN
PurchaseType:
type: string
description: Tipo de compra que está sendo autenticada.
enum:
- GoodsOrService
- CheckAcceptance
- AccountFunding
- QuasiCash
- PrepaidActivation
Channel:
type: string
description: Canal em que ocorre a transação.
default: WEB
enum:
- WEB
- APP
- MWEB
- THREERI
AddressMatch:
type: string
description: "O endereço de entrega corresponde ao endereço de cobrança.\
\ Y = endereços de envio e cobrança são iguais, N = endereços de envio\
\ e cobrança são diferentes. O valor é 1 caracter."
MerchantAdditionalData:
$ref: '#/components/schemas/MerchantAdditionalData'
PaymentInfo:
$ref: '#/components/schemas/PaymentInfo'
BillingAddress:
$ref: '#/components/schemas/Address'
ShippingAddress:
$ref: '#/components/schemas/Address'
ShoppingCart:
type: array
items:
$ref: '#/components/schemas/CartItem'
ConsumerInfo:
$ref: '#/components/schemas/ConsumerContact'
ConsumerWalletInfo:
$ref: '#/components/schemas/WalletInfo'
DeviceInfo:
$ref: '#/components/schemas/Device'
RiskProviderInfo:
$ref: '#/components/schemas/RiskProvider'
TriggeredRuleName:
type: string
description: 'Nome da regra disparada durante o processamento de risco.'
RecurringInfo:
type: object
properties:
RecurringFrequency:
type: string
description: 'Indica o número mínimo de dias entre autorizações. Up to 4 caracteres.'
format: string
RecurringExpiry:
type: string
description: 'Data de validade do cartão cadastrado para a transação; AAAAMMDD. 8 caracteres.'
format: date
ThreeDSRequestorPriorAuthenticationInfo :
type: object
properties:
threeDSReqPriorAuthData:
type: string
description: 'Dados que documentam e suportam um processo de autenticação específico. Up to 2048 caracteres.'
format: string
threeDSReqPriorAuthMethod:
type: string
description: 'Mecanismo utilizado pelo Titular do Cartão para se autenticar previamente no Solicitante 3DS. 2 caracteres.'
format: string
threeDSReqPriorAuthTimestamp:
type: string
description: 'Data e hora em UTC da autenticação anterior do titular do cartão. 12 caracteres.'
format: date
threeDSReqPriorRef:
type: string
description: 'Fornece informações adicionais ao ACS para determinar a melhor abordagem para atender uma solicitação. 36 caracteres.'
format: string
TransStatusReason:
type: string
description: 'Fornece informações sobre o campo Transaction Status possui o valor especificado. 2 caracteres.'
format: string
StepupRequestTransactionInfo:
type: object
properties:
TransactionTimeStamp:
type: string
description: Data e hora da transação em UTC de acordo com ISO 8601 UTC;
por exemplo. 21-03-2024T20:55:49.000Z
format: date-time
TransactionAmount:
type: number
description: "Valor da transação (valor bruto, exemplo 1000 por US$ 10,00).\
\ Até 48 caracteres."
format: decimal
TransactionCurrency:
type: string
description: "ISO 4217; Padrão numérico de 3 dígitos. Referência: [ISO 4217\
\ Link] https://en.wikipedia.org/wiki/ISO_4217 Até 3 caracteres."
default: "840"
TransactionExponent:
type: integer
description: Expoente para formatar o código ISO 4217 da moeda fornecida.
Até um caracter.
TransactionType:
type: string
description: Tipo da transação.
enum:
- Purchase
- CardAdd
MandatedRegion:
type: string
description: "Um valor que descreve a região na qual a regulamentação pode\
\ ser aplicados à transação atual. Adicionado para suportar as novas transaç\
ões PSD2 no EEA. Nota: Este valor não estará presente a menos que o emissor\
\ trabalhe com seu gerenciador de integração para ativar os recursos do\
\ PSD2. Nota: Deve-se levar em conta novos valores adicionados a este\
\ campo ao longo do tempo devido a novas regulamentações implementadas\
\ em outras regiões."
enum:
- EEA
- NONE
- UNKNOWN
Channel:
type: string
description: Canal em que ocorre a transação.
default: WEB
enum:
- WEB
- APP
- MWEB
- THREERI
InitiateActionTransactionInfo:
type: object
properties:
TransactionTimeStamp:
type: string
description: Data e hora da transação em UTC de acordo com ISO 8601 UTC;
por exemplo. 21-03-2024T20:55:49.000Z
format: date-time
TransactionAmount:
type: number
description: "Valor da transação (valor bruto, exemplo 1000 por US$ 10,00).\
\ Até 48 caracteres."
format: decimal
TransactionCurrency:
type: string
description: "ISO 4217; Padrão numérico de 3 dígitos. Referência: [ISO 4217\
\ Link] https://en.wikipedia.org/wiki/ISO_4217 Até 3 caracteres."
default: "840"
TransactionExponent:
type: integer
description: Expoente para formatar o código ISO 4217 da moeda fornecida.
Até um caracter.
TransactionType:
type: string
description: Tipo da transação.
enum:
- Purchase
- CardAdd
MandatedRegion:
type: string
description: "Um valor que descreve a região na qual a regulamentação pode\
\ ser aplicados à transação atual. Adicionado para suportar as novas transaç\
ões PSD2 no EEA. Nota: Este valor não estará presente a menos que o emissor\
\ trabalhe com seu gerenciador de integração para ativar os recursos do\
\ PSD2. Nota: Deve-se levar em conta novos valores adicionados a este\
\ campo ao longo do tempo devido a novas regulamentações implementadas\
\ em outras regiões."
enum:
- EEA
- NONE
- UNKNOWN
Channel:
type: string
description: Canal em que ocorre a transação.
default: WEB
enum:
- WEB
- APP
- MWEB
- THREERI
Credential:
required:
- Id
- Type
type: object
properties:
Id:
type: string
description: "Identifier for the credential requested, this will be passed\
\ on the InitiateAction request as well as the ValidateRequest. Até 36\
\ caracteres. The Id must be unique per credential object returned. The\
\ Id is used to distinguish the specific authenticate type in preceding\
\ InitiateAction and ValidateRequest calls."
Type:
type: string
description: "Type of the Credential used for stepup, this is meta data\
\ and will not be used in any business logic."
enum:
- OTPEMAIL
- OTPSMS
- OTPIVR
- KBASINGLE
- BIOMETRIC
- OUTOFBANDOTHER
- OUTOFBANDTOKEN
Text:
type: string
description: "Dynamic data to be displayed to the cardholder i.e. masked\
\ phone number or email address. Nota: certain browser screen templates\
\ will only be able to show a certain number of caracteres before showing\
\ an elipsis (...). Até 35 caracteres. Nota: in EMV SDK flows the text\
\ space is limited. Até 40 caracteres."
CredentialStepup:
type: object
properties:
CustomerId:
type: string
description: ID do cliente do emissor para criação/construção de perfil
biométrico comportamental. Até 36 caracteres.
Id:
type: string
description: "Identificador da credencial solicitada, que será repassada\
\ na solicitação InitiateAction e também no ValidateRequest. O comprimento\
\ deve ser de 36 caracteres. Nota: O ID deve ser exclusivo por objeto\
\ de credencial retornado. O Id é usado para distinguir o tipo de credencial\
\ específico e a credencial do titular do cartão nas chamadas InitiateAction\
\ e ValidateRequest anteriores. Até 36 caracteres."
Type:
type: string
description: Tipo de credencial usada para Stepup.
enum:
- OTPEMAIL
- OTPSMS
- OTPIVR
- KBASINGLE
- BIOMETRIC
- OUTOFBANDOTHER
- OUTOFBANDTOKEN
Text:
type: string
description: "Dados dinâmicos a serem exibidos ao titular do cartão, por\
\ examplo, número de telefone ou endereço de e-mail mascarado. Certos\
\ modelos de navegador exibirão apenas um número limitado de caracteres\
\ antes de mostrar reticências (...). Até 35 caracteres. Nos fluxos EMV\
\ SDK, o espaço de texto é limitado a 40 caracteres."
Token:
type: string
description: O campo Token estará contido na solicitação de postagem ao
emissor e postado no iframe. Disponível apenas para StepupType OUTOFBAND_EMBEDDED.
Obrigatório quando o Credential.Type é OUTOFBANDTOKEN
CredentialValidate:
type: object
properties:
Id:
type: string
description: Valor de ID do StepupResponse ➤ Credential. Até 36 caracteres.
Type:
type: string
description: O valor do tipo de credencial que foi retornado na resposta
de etapa RDX. O RDX enviará este campo na chamada de Validate.
enum:
- OTPEMAIL
- OTPSMS
- OTPIVR
- KBASINGLE
- BIOMETRIC
- OUTOFBANDOTHER
- OUTOFBANDTOKEN
Value:
type: string
description: Valor fornecido pelo titular do cartão. Obrigatório com tipos
de resposta OTP e KBA. Não aplicável a outros tipos de resposta.
BehavioralBiometricsResult:
type: object
properties:
CustomerId:
type: string
description: ID do cliente do emissor para criar/construir um perfil de
Biometria Comportamental.
Decision:
type: string
description: "Retorna resultado da decisão de Biometria Comportamental (ALLOW,\
\ DENY, ERROR)."
RiskScore:
type: string
description: Pontuação (Score) indicando o resultado da decisão da Biometria
Comportamental.
ExemptionInfo:
type: object
properties:
MerchantFraudRate:
type: string
description: "Taxa de fraude do Estabalecimento. Valor de 1 ou 2 caracteres.\
\ Nota: Atualmente disponível apenas em transações Mastercard EMV 3DS\
\ onde os dados de extensão estão presentes. Estará disponível em futuras\
\ versões EMV. Nota: Taxa de fraude no EEE calculada de acordo com PSD2\
\ RTS. A Mastercard não calculará nem validará a pontuação de fraude do\
\ estabelecimento."
example: "1"
SecureCorporatePayment:
type: string
description: "Indica que foram utilizados processos e procedimentos de pagamento\
\ dedicados e que pode ser aplicada uma isenção de pagamento corporativo\
\ seguro. Logicamente este campo só deve ser definido como Sim (Y) se\
\ o campo de isenção do adquirente estiver em branco. Um estabelecimento\
\ não pode reivindicar isenção do adquirente e pagamento seguro. Poré\
m, o DS não validará as condições da extensão. O DS transmitirá os dados\
\ conforme apresentados. Nota: Atualmente disponível apenas em transaç\
ões Mastercard EMV 3DS onde os dados de extensão estão presentes."
example: "Y"
MCRiskScore:
type: string
description: "Pontuação de risco Mastercard fornecida na extensão de mensagem\
\ AReq. Este campo é configurável pelos emissores, porém os emissores\
\ devem solicitar a habilitação deste recurso. Aplicável apenas para transaç\
ões Mastercard."
example: "123"
WhitelistStatus:
type: string
description: Indica o status atual da lista de permissões conforme indicado
pelo Servidor 3DS e pelo DS na solicitação de autenticação.
enum:
- "Y"
- "N"
- E
- P
- R
- U
WhitelistStatusSource:
type: string
description: Indica a origem da solicitação de inclusão na lista de permissões.
Este será o valor inicial enviado ao VCAS na solicitação de autenticação.
enum:
- Merchant
- DS
description: Objeto que contém informações relacionadas às isenções de EMV relacionadas
aos regulamentos EEA PSD2.
ExemptionResponse:
type: object
properties:
WhitelistStatus:
type: string
description: Indica se a transação fez parte da lista de permissões. Deve
ser usado em conjunto com o status da chamada RiskResponse.Status. O valor
pode ser deixado nulo se for aceito ou se não aplicável à transação.
enum:
- "Y"
- "N"
- E
- P
- R
- U
description: Objeto contendo qualquer informação relacionada à avaliação do
ExemptionInfo no RiskRequest.
MerchantAuthInfo:
type: object
properties:
DecoupledRequestIndicator:
type: string
description: "Indica se o Solicitante 3DS requer que o ACS utilize a Autenticaç\
ão Desacoplada e concorda em utilizar a Autenticação Desacoplada se o\
\ ACS confirmar seu uso. Nota: Atualmente não disponível; pode estar disponí\
vel em breve."
enum:
- DecoupledPreferred
- NoDecoupledPreferred
DecoupledMaxTime:
type: string
description: "Indica o tempo máximo que o Solicitante 3DS aguardará que\
\ um ACS forneça os resultados da transação de Autenticação Desacoplada\
\ (em minutos). Valores numéricos entre 1 e 10080 são aceitos. Nota: Atualmente\
\ não disponível; pode estar disponível em breve."
description: Objeto contendo informações relacionadas a qualquer Merchant Authentication
informações sobre solicitações de EMV.
CardholderSelectionInfo:
type: object
properties:
Type:
type: string
description: Digite descrevendo a seleção do titular do cartão; por exemplo.
Titular do cartão primário ou secundário.
enum:
- P
- S
Name:
type: string
description: O nome do titular do cartão selecionado. Necessário apenas
se um titular de cartão secundário for selecionado para correspondência.
description: Object defining the consumers selection during the Cardholder Selection
OTP flow. This feature is only populated and enabled for issuers supporting
this flow.
EmbeddedOOBResponseUrl:
type: string
description: "O emissor deve redirecionar para esse URL quando a validação for\
\ concluída, durante um desafio OOB (Out-of-Band) habilitado."
Reason:
type: object
properties:
ReasonCode:
type: string
description: Usado pelo emissor para fim informativo. Até 32 caracteres.
ReasonDescription:
type: string
description: Usado pelo emissor para fim informativo. Até 256 caracteres.
WhyInfo:
type: object
properties:
Label:
type: string
description: Informação a ser exibida ao titular do cartão na seção de informações
"por que".
Text:
type: string
description: "Texto fornecido pelo emissor para ser exibido ao titular do\
\ cartão para explicar por que o titular do cartão está sendo solicitado\
\ a realizar a tarefa de autenticação. Nota: O retorno da operadora carro\
\ é suportado neste elemento de dados e é representado por um “\\n”. A\
\ exibição deste campo nas telas do consumidor está limitada a 35 caracteres."
description: "Object defining dynamic text values that can be shown to the consumer\
\ during the challenge flow. These fields will be mapped directly to both\
\ browser templates and SDK info fields. Nota: this field is also configurable\
\ for SDK screens today via our template configuration. If this value is passed\
\ on RDX it will override the current configurable value."
ErrorMessage:
type: object
properties:
ReferenceNumber:
type: string
description: Número de referência do sistema para a mensagem de erro. Até
15 caracteres.
ReasonDescription:
type: string
description: Utilizado pelo emissor para fim informativo. Até 256 caracteres.
Description:
type: string
description: Descrição do erro. Até 50 caracteres.
Message:
type: string
description: "Uma mensagem que pode ser usada para exibir texto ao titular\
\ do cartão em determinados modelos. Os status suportados para este campo\
\ são BLOCKED, ERROR e FAILWITHFEEDBACK. Nota: o Emissor também deve estar\
\ configurado para tela de erro para que o status ERROR funcione corretamente.Para\
\ transações EMV 3DS este valor será inserido em um campo de mensagem\
\ que será enviado de volta ao Lojista. Este campo deve ter no máximo\
\ 128 caracteres e não é combinado com nenhum outro dado. Se este campo\
\ for omitido, qualquer conteúdo estático armazenado para o Emissor e\
\ o modelo será retornado. Até 128 caracteres."
RReqOverrides:
type: object
properties:
AuthenticationMethod:
type: string
description: Método de autenticação obrigatório para os valores RReq e Visa
CAVV.
enum:
- SMS_OTP
- HARDWARE_OTP
- SOFTWARE_OTP
- OTHER_OTP
- KBA
- BIOMETRIC
- APP_LOGIN
- OTHER
TransStatusReason:
type: string
description: Obrigatório quando a transação não é autenticada ou quando ocorre um erro no caso de uso OOB incorporado.
enum:
- CARD_AUTH_FAILED
- EXCEEDS_FREQUENCY
- TECHNICAL_ISSUE
AuthenticationAttempts:
type: string
description: Indica o número de ciclos de autenticação tentados pelo titular
do cartão. O valor deve ser igual a 2 caracteres (01-99).
CustomerCancel:
type: boolean
description: "Indica se o cliente cancelou a transação. Verdadeiro se o\
\ cliente clicou em “Cancelar”, caso contrário, falso. Obrigatório para\
\ o caso de uso de OOB embedded."
RiskRequest:
required:
- IssuerId
- MerchantInfo
- MessageVersion
- ProcessorId
- TransactionId
- TransactionInfo
type: object
properties:
ProcessorId:
type: string
description: Identificação do cliente provida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Identificação do cliente provida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab080
TransactionId:
type: string
description: ID de referência de transação gerada pelo VCAS; Valor GUID
de 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
DSTransactionId:
type: string
description: ID de referência de transação gerada pelo Directory Server
(DS). Formato GUID.
default: 521fa021-4791-4579-a3e9-76de87c219c0
MerchantChallengeIndicator:
type: string
description: "Indica se um desafio é solicitado ao comerciante. Nota: Please\
\ allow for future values in this field. EMV has reserved Até 99 values\
\ for future use."
enum:
- NoPreference
- NoChallenge
- PreferChallenge
- MandatedChallenge
- NoChallengeRiskPerformed
- NoChallengeDataOnly
- NoChallengeSCAPerformed
- NoChallengeWhitelistExempt
- PreferChallengeWhitelistPrompt
3RIIndicator:
type: string
description: 'Indica o tipo de solicitação 3RI para transações EMV. Nota: Deve-se permitir valores futuros neste campo. A EMV reservou até 99 valores para uso futuro.'
enum:
- RecurringTransaction
- InstallmentTransaction
- AddCard
- MaintainCardInformation
- AccountVerification
- SplitOrDelayedShipment
- TopUp
- MailOrder
- TelephoneOrder
- WhitelistStatusCheck
- OtherPayment
NonPaymentAuthenticationIndicator:
type: string
description: Indica o tipo de autenticação sem pagamento (NPA).
enum:
- Payment Transaction
- Recurring Transaction
- Instalment Transaction
- AddCard
- MaintainCard
- CardholderVerification
MessageVersion:
type: string
description: "Versão do protocolo 3DS baseado nas especificações 3DS. Exemplos\
\ - 2.1.0, 2.2.0"
default: 2.2.0
RDXMessageVersion:
type: string
description: "Versão do protocolo RDX em uso. Usado para habilitar novos\
\ recursos sem quebra de integrações atuais. Exemplo: 2.2.2 and 2.2.3"
default: 2.2.3
MessageCategory:
type: string
description: Identifies the category of the message for a specific use case; 01=PA, 02=NPA
default: 01
RiskScore:
type: string
description: Pontuação de risco da transação conforme determinado pelo VCAS.
Até 2 caracteres.
RuleOutcome:
type: string
description: "Se a transação estiver configurada para avaliar regras de\
\ risco, este será o resultado dessa avaliação."
enum:
- Success
- Fail
- FailWithFeedback
- Challenge
- Rejected
- Error
ExemptionInfo:
$ref: '#/components/schemas/ExemptionInfo'
MerchantAuthInfo:
$ref: '#/components/schemas/MerchantAuthInfo'
MerchantInfo:
$ref: '#/components/schemas/MerchantInfo'
TransactionInfo:
$ref: '#/components/schemas/RiskRequestTransactionInfo'
ExtensionData:
$ref: '#/components/schemas/DAFExtension'
RiskResponse:
required:
- IssuerId
- ProcessorId
- Status
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Repetido da chamada RiskRequest. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Repetido da chamada RiskRequest. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab081
TransactionId:
type: string
description: Repetido da chamada RiskRequest. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
Status:
type: string
description: Status da chamada Risk Request.
enum:
- SUCCESS
- STEPUP
- FAILURE
- FAILWITHFEEDBACK
- ERROR
- BLOCKED
- REJECTED
TransStatusReason:
$ref: '#/components/schemas/TransStatusReason'
Language:
type: string
description: "Idioma para exibir as instruções e solicitar ao titular do\
\ cartão. Este valor decidirá qual modelo será carregado, desde que o\
\ modelo de idioma esteja disponível. Se não for fornecido, o idioma será\
\ selecionado com base na configuração do emissor e na preferência do\
\ navegador."
RiskIndicator:
type: string
description: |
Se retornado, esse valor será usado na criação de determinados Valores de Autenticação (AV) para EMV 3DS.
O valor passado deve estar em conformidade com o valor AV atual que o Emissor está usando. Isso também pode depender da bandeira do cartão da transação. Por exemplo, CAVV e IAV aceitam valores diferentes.
Nota: O valor aqui será convertido para o equivalente hexadecimal. Consulte o documento “VCAS Enhanced Authentication Value Support Guide” para obter mais detalhes sobre os AVs atuais disponíveis e os valores correspondentes.
RiskScore:
type: string
description: Pontuação ou valor de risco conforme determinado pelo cliente
ou pelo VCAS Risk Engine. Até 2 caracteres.
ExemptionResponse:
$ref: '#/components/schemas/ExemptionResponse'
Reason:
$ref: '#/components/schemas/Reason'
Error:
$ref: '#/components/schemas/ErrorMessage'
StepupRequest:
required:
- IssuerId
- MessageVersion
- ProcessorId
- StepupCounter
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Identificação do cliente provida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Identificação do cliente provida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab083
TransactionId:
type: string
description: ID de referência de transação gerada pelo VCAS; Valor GUID
de 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
DSTransactionId:
type: string
description: ID de referência de transação gerada pelo Directory Server
(DS). Formato GUID.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f987
3RIIndicator:
type: string
description: 'Indica o tipo de solicitação 3RI para transações EMV. Nota: Deve-se permitir valores futuros neste campo. A EMV reservou até 99 valores para uso futuro.'
enum:
- RecurringTransaction
- InstallmentTransaction
- AddCard
- MaintainCardInformation
- AccountVerification
- SplitOrDelayedShipment
- TopUp
- MailOrder
- TelephoneOrder
- WhitelistStatusCheck
- OtherPayment
ThreeDSRequestorAuthenticationInd:
type: string
description: 'Indicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handling an authentication request.'
enum:
- Payment Transaction
- Recurring Transaction
- Instalment Transaction
- AddCard
- MaintainCard
- CardholderVerification
StepupRequestId:
type: string
description: Identificador exclusivo para identificar a solicitação Stepup
específica. Até 36 caracteres.
default: 878f4751-4140-4881-9e4a-003e83524f22
StepupCounter:
type: integer
description: "Contador para o número de chamadas Stepup. Cada ciclo Stepup\
\ pode seguir o fluxo Stepup ➤ InitiateAction ➤ Validate. Se o usuário\
\ solicitar um \"reenvio\" por meio do navegador ou de modelos de aplicativos\
\ nativos, ele iniciará outra solicitação de Stepup. Nota: O valor inicial\
\ será 0 (zero)."
DeviceLocale:
type: string
description: "Localidade do dispositivo no cabeçalho do navegador ou nas\
\ configurações de idioma do aplicativo nativo. Esse valor pode ser um\
\ único valor de localidade ou vários valores concatenados por vírgulas.\
\ No EMV 3DS isso não está disponível devido a novos fluxos, portanto\
\ este será um valor de idioma único seguindo o formato BCP 47; e.g. en-US\
\ ou en,es-PE;q=0.9,es;q=0.8"
default: en-US
DeviceUserAgent:
type: string
description: Agente de usuário do dispositivo no cabeçalho do navegador
ou no identificador de dispositivo do aplicativo. Até 2048 caracteres.
default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,\
\ like Gecko) Chrome/87.0.4280.88 Safari/537.36"
MessageVersion:
type: string
description: "Versão do protocolo 3DS baseado nas especificações 3DS. Esta\
\ versão será incrementada a cada nova especificação lançada pela EMVCo\
\ para 2.x. Isso normalmente seguirá um formato de versão X.Y.Z. Exemplos\
\ 2.1.0, 2.2.0"
default: 2.2.0
RDXMessageVersion:
type: string
description: "Versão do protocolo RDX em uso. Usado para habilitar novos\
\ recursos sem quebra de integrações atuais. Exemplo: 2.2.2 and 2.2.3"
default: 2.2.3
MessageCategory:
type: string
description: Identifica a categoria da mensagem para um caso de uso específico; 01=PA, 02=NPA
default: '01'
StepupReason:
type: string
description: "O motivo pelo qual a solicitação Stepup foi iniciada. Exemplo:\
\ CARDHOLDER_RESEND - Quando o titular do cartão é desafiado e clica no\
\ botão Reenviar na página de validação de OTP, a próxima solicitação\
\ Stepup conterá este valor. Nota: Disponível apenas para Reenvio do Titular\
\ do Cartão, podendo ser acrescidos valores e cenários futuros."
enum:
- CARDHOLDER_RESEND
MerchantInfo:
$ref: '#/components/schemas/MerchantAppRedirectURLInfo'
PaymentInfo:
$ref: '#/components/schemas/PaymentInfo'
TransactionInfo:
$ref: '#/components/schemas/StepupRequestTransactionInfo'
CardholderSelectionInfo:
$ref: '#/components/schemas/CardholderSelectionInfo'
EmbeddedOOBResponseUrlInfo:
$ref: '#/components/schemas/EmbeddedOOBResponseUrl'
StepupResponse:
required:
- Credentials
- IssuerId
- ProcessorId
- Status
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Repetido da chamada de Request. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Repetido da chamada de Request. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab088
isBbConsentRequired:
type: string
description: Indica se o consentimento legal é necessário para o fluxo de
biometria comportamental. Boolean.
TransactionId:
type: string
description: Repetido da chamada de Reques. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
StepupRequestId:
type: string
description: Repetido da chamada de Reques. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f321
StepupType:
type: string
description: "Usado para identificar o tipo de Stepup. Se StepupType estiver\
\ incluído na resposta, o StepupResponse.Credential também deve ser retornado."
enum:
- CHOICE
- OTP
- KBA
- BIOMETRIC
- OUTOFBAND
- OTP_AND_KBA
- OTP_CHOICE_AND_KBA
- OUTOFBAND_EMBEDDED
TransStatusReason:
$ref: '#/components/schemas/TransStatusReason'
Language:
type: string
description: "Idioma para exibir as instruções e solicitar ao titular do\
\ cartão. Este valor decidirá qual modelo será carregado, desde que o\
\ modelo de idioma esteja disponível. Se não for fornecido, o idioma será\
\ selecionado com base na configuração do emissor e na preferência do\
\ navegador."
Status:
type: string
description: "Status da solicitação de risco. Nota: Quando o status AUTHENTICATED\
\ for retornado para EMV 3DS, o authenticityType será ‘10’ - Outro."
enum:
- SUCCESS
- AUTHENTICATED
- FAILURE
- FAILWITHFEEDBACK
- ERROR
- BLOCKED
- REJECTED
- INFORMATION ONLY
RiskIndicator:
type: string
description: |
Se retornado, esse valor será usado na criação de determinados Valores de Autenticação (AV) para EMV 3DS.
O valor passado deve estar em conformidade com o valor AV atual que o emissor está usando. Isso também pode depender da marca do cartão da transação. Por exemplo, CAVV e IAV aceitam valores diferentes.
Nas respostas do StepUp (Stepup, InitiateAction, Validate) este valor é atualmente ignorado para usos de CAVV em favor do mapeamento para o “Tipo de Credencial”. Para uso do Enhanced IAV SPA2, se aprovado, esse valor substituirá o mapeamento para o “Tipo de credencial”.
Nota: Este valor será convertido em um equivalente hexadecimal.
oobAppURL:
type: string
description: 'Link de aplicativo universal para um aplicativo de autenticação usado na autenticação OOB. A URL do aplicativo abrirá o local apropriado no aplicativo de autenticação. O emissor é exigido em transações baseadas em aplicativos Mastercard de acordo com os requisitos Mastercard Brinding Extension para transações 2.2. Max. 2048 caracteres.'
Credentials:
type: array
items:
$ref: '#/components/schemas/CredentialStepup'
Reason:
$ref: '#/components/schemas/Reason'
Error:
$ref: '#/components/schemas/ErrorMessage'
WhyInfo:
$ref: '#/components/schemas/WhyInfo'
InitiateActionRequest:
required:
- Credentials
- IssuerId
- MessageVersion
- ProcessorId
- StepupCounter
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Identificação fornecida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Identificação fornecida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab654
TransactionId:
type: string
description: "ID de referência de transação gerada por VCAS: valor GUID de 36 caracteres."
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
DSTransactionId:
type: string
description: ID de referência de transação gerada pelo Directory Server
(DS). Formato GUID.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f258
3RIIndicator:
type: string
description: 'Indica o tipo de solicitação 3RI para transações EMV. Nota: Deve-se permitir valores futuros neste campo. A EMV reservou até 99 valores para uso futuro.'
enum:
- RecurringTransaction
- InstallmentTransaction
- AddCard
- MaintainCardInformation
- AccountVerification
- SplitOrDelayedShipment
- TopUp
- MailOrder
- TelephoneOrder
- WhitelistStatusCheck
- OtherPayment
ThreeDSRequestorAuthenticationInd:
type: string
description: 'Indicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handling an authentication request.'
enum:
- Payment Transaction
- Recurring Transaction
- Instalment Transaction
- AddCard
- MaintainCard
- CardholderVerification
StepupRequestId:
type: string
description: ID exclusivo para identificar a solicitação Stepup específica.
O comprimento é de 36 caracteres. Até 36 caracteres.
default: 878f4751-4140-4881-9e4a-003e83524f22
StepupType:
type: string
description: "O valor do campo StepupType que foi retornado na chamada Stepup\
\ Response do RDX, será retornada na chamada InitiateAction."
enum:
- CHOICE
- OTP
- KBA
- BIOMETRIC
- OUTOFBAND
- OTP_AND_KBA
- OTP_CHOICE_AND_KBA
StepupCounter:
type: integer
description: "Contador para o número de chamadas Stepup. Cada ciclo Stepup\
\ pode seguir o fluxo Stepup ➤ InitiateAction ➤ Validate. Se o usuário\
\ solicitar um \"reenvio\" por meio do navegador ou de modelos de aplicativos\
\ nativos, ele iniciará outra solicitação de Stepup. Nota: O valor inicial\
\ será 0 (zero)."
OtpReferenceCode:
type: string
description: "Este é um valor único gerado a cada novo valor OTP ou “VerificationToken”\
. No caso em que o consumidor pode receber vários OTPs para a mesma transaç\
ão, isso pode ser aproveitado para mostrar ao consumidor qual OTP o sistema\
\ espera que seja inserido. Este valor deverá ser enviado no SMS ou Email\
\ junto com o VerificationToken e depois exibido na tela do consumidor.\
\ Nota: Se o emissor pretender usar este campo, deverá consultar seu representante\
\ VCAS para garantir que este campo seja exibido nas telas voltadas para\
\ o consumidor."
VerificationToken:
type: string
description: Token (OTP) a ser enviado ao titular do cartão.
MessageVersion:
type: string
description: "Versão do protocolo 3DS baseado nas especificações 3DS. Exemplos\
\ - 2.1.0, 2.2.0"
default: 2.2.0
RDXMessageVersion:
type: string
description: "Versão do protocolo RDX em uso. Usado para habilitar novos\
\ recursos sem quebra de integrações atuais. Exemplo: 2.2.2 and 2.2.3"
default: 2.2.3
MessageCategory:
type: string
description: Identifies the category of the message for a specific use case; 01=PA, 02=NPA
default: '01'
Credentials:
type: array
items:
$ref: '#/components/schemas/Credential'
MerchantInfo:
$ref: '#/components/schemas/MerchantAppRedirectURLInfo'
PaymentInfo:
$ref: '#/components/schemas/PaymentInfo'
TransactionInfo:
$ref: '#/components/schemas/InitiateActionTransactionInfo'
InitiateActionResponse:
required:
- Credentials
- IssuerId
- ProcessorId
- Status
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Echoed from Request. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Echoed from Request. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab963
TransactionId:
type: string
description: Echoed from Request. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
StepupRequestId:
type: string
description: Echoed from Request. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f761
TransStatusReason:
$ref: '#/components/schemas/TransStatusReason'
Language:
type: string
description: "Idioma para exibir as instruções e solicitar ao titular do\
\ cartão. Este valor decidirá qual modelo será carregado, desde que o\
\ modelo de idioma esteja disponível. Se não for fornecido, o idioma será\
\ selecionado com base na configuração do emissor e na preferência do\
\ navegador."
Status:
type: string
description: ERROR é devolvido em qualquer problema interno/técnico. AUTHENTICATED
retornará um Y de volta ao comerciante.
enum:
- SUCCESS
- AUTHENTICATED
- STEPUP
- FAILURE
- FAILWITHFEEDBACK
- ERROR
- BLOCKED
- REJECTED
RiskIndicator:
type: string
description: |
Se retornado, esse valor será usado na criação de determinados Valores de Autenticação (AV) para EMV 3DS.
O valor enviado deve estar em conformidade com o valor AV atual que o emissor está usando. Isso também pode depender da bandeira do cartão da transação. Por exemplo, CAVV e IAV aceitam valores diferentes.
Nas respostas do Desafio (Stepup, InitiateAction, Validate) este valor é atualmente ignorado para usos de CAVV em favor do mapeamento para o “Credential Type”. Para o uso do Enhanced IAV SPA2, se enviado, esse valor substituirá o mapeamento para o “Tipo de credencial”.
Nota: Este valor será convertido em um equivalente hexadecimal.
maximum: 3
Credentials:
type: array
items:
$ref: '#/components/schemas/Credential'
Reason:
$ref: '#/components/schemas/Reason'
Error:
$ref: '#/components/schemas/ErrorMessage'
ValidateRequest:
required:
- CredentialResponse
- IssuerId
- MessageVersion
- ProcessorId
- StepupCounter
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Identificação fornecida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Identificação fornecida pelo VCAS. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab481
TransactionId:
type: string
description: "ID de referência de transação gerada por VCAS: valor GUID\
\ de 36 caracteres."
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
StepupType:
type: string
description: "O valor StepupType que foi retornado na resposta Stepup RDX,\
\ o RDX enviará esse campo na chamada ValidateRequest."
enum:
- CHOICE
- OTP
- KBA
- BIOMETRIC
- OUTOFBAND
- OUTOFBANDOTHER
- OTP_AND_KBA
- OTP_CHOICE_AND_KBA
DSTransactionId:
type: string
description: ID de referência de transação gerada pelo Directory Server
(DS). Formato GUID.
default: 521fa021-4791-4579-a3e9-76de87c219c0
FirstFactorOutcome:
type: string
description: "Será fornecido o resultado da primeira autenticação. O status\
\ a seguir não deve ser aplicado ao Resultado do Primeiro Fator, a menos\
\ que o cliente esteja realizando a validação no primeiro fator e os retorne\
\ na resposta RDX Validate do primeiro fator."
enum:
- SUCCESS
- FAILURE
- RETRY
- PENDING
- FAILWITHFEEDBACK
- BLOCKED
- REJECTED
StepupRequestId:
type: string
description: ID exclusivo para identificar a solicitação Stepup específica.
O comprimento é de 36 caracteres.
default: 878f4751-4140-4881-9e4a-003e83524f22
StepupCounter:
type: integer
description: "Contador para o número de chamadas Stepup. Cada ciclo Stepup\
\ pode seguir o fluxo Stepup ➤ InitiateAction ➤ Validate. Se o usuário\
\ solicitar um \"reenvio\" por meio do navegador ou de modelos de aplicativos\
\ nativos, ele iniciará outra solicitação de Stepup. Nota: O valor inicial\
\ será 0 (zero)."
MessageVersion:
type: string
description: "Versão do protocolo 3DS baseado nas especificações 3DS. Exemplos\
\ - 2.1.0, 2.2.0"
default: 2.2.0
RDXMessageVersion:
type: string
description: "Versão do protocolo RDX em uso. Usado para habilitar novos\
\ recursos sem quebra de integrações atuais. Exemplo: 2.2.2 and 2.2.3"
default: 2.2.3
BehavioralBiometricsResult:
$ref: '#/components/schemas/BehavioralBiometricsResult'
CredentialResponse:
type: array
items:
$ref: '#/components/schemas/CredentialValidate'
ValidateResponse:
required:
- IssuerId
- ProcessorId
- Status
- StepupRequestId
- TransactionId
type: object
properties:
ProcessorId:
type: string
description: Repetido da chamada de Request. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab079
IssuerId:
type: string
description: Repetido da chamada de Request.. Até 24 caracteres.
default: 5723ae630063ac1a9c3ab671
TransactionId:
type: string
description: Repetido da chamada de Request. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f412
StepupRequestId:
type: string
description: Repetido da chamada de Request. Até 36 caracteres.
default: 00ec043e-40b5-4ce4-95c2-9e83b644f618
TransStatusReason:
$ref: '#/components/schemas/TransStatusReason'
Language:
type: string
description: "Idioma para exibir as instruções e solicitar ao titular do\
\ cartão. Este valor decidirá qual modelo será carregado, desde que o\
\ modelo de idioma esteja disponível. Se não for fornecido, o idioma será\
\ selecionado com base na configuração do emissor e na preferência do\
\ navegador. e.g. en-US. Até 8 caracteres."
CredentialId:
type: string
description: Valor de ID de StepupResponse ➤ Credential. Até 36 caracteres.
Status:
type: string
description: Status da solicitação de validação.
enum:
- SUCCESS
- RETRY
- STEPUP
- PENDING
- FAILURE
- FAILWITHFEEDBACK
- ERROR
- BLOCKED
- REJECTED
RiskIndicator:
type: string
description: |
Se retornado, esse valor será usado na criação de determinados Valores de Autenticação (AV) para EMV 3DS.
O valor enviado deve estar em conformidade com o valor AV atual que o emissor está usando. Isso também pode depender da bandeira do cartão da transação. Por exemplo, CAVV e IAV aceitam valores diferentes.
Nas respostas do Desafio (Stepup, InitiateAction, Validate) este valor é atualmente ignorado para usos de CAVV em favor do mapeamento para o “Credential Type”. Para o uso do Enhanced IAV SPA2, se enviado, esse valor substituirá o mapeamento para o “Tipo de credencial”.
Nota: Este valor será convertido em um equivalente hexadecimal.
Reason:
$ref: '#/components/schemas/Reason'
Error:
$ref: '#/components/schemas/ErrorMessage'
RReqOverrides:
$ref: '#/components/schemas/RReqOverrides'
Updated 9 days ago