Gerar VCN

POST 
/vcn

Gera um número de cartão de crédito virtual (VCN). Os dados do VCN são incluídos no corpo da resposta por padrão, mas é possível solicitar a geração de um token, que será necessário para restaurar os dados do cartão no momento da cobrança.

Request

application/json

Body

echoToken string

Identificação da requisição. O mesmo valor será retornado no atributo do response.

vcnTimestamp date-timerequired

Data da criação da requisição: YYYY-MM-DDThh:mm:ss.sTZD.

vcnCreditLimit numberrequired
vcnCreditLimitCurrencyCode stringrequired

Moeda do limite do cartão. Código alpha padrão ISO 4217

vcnCardHolderName stringrequired

Nome do portador no cartão.

vcnActivationDate daterequired

Data de ativação do cartão. Máximo é a data de expiração do cartão, ou um ano no futuro.

vcnExpirationDate daterequired

Data de fim de validade do uso do cartão. Máximo é um ano no futuro, a contar da data da criação do VCN.

orderLocator stringrequired

Código da solicitação/ requisição

orderRequestorName stringrequired

Nome do solicitante.

orderRequestorCPF string

CPF do solicitante

orderRequestorPhone string

Número do telefone do solicitante.

orderRequestorEmail stringrequired

Endereço de e-mail do solicitante.

orderRequestorAddress string

Endereço do solicitante.

orderRequestorZipCode string

CEP do endereço.

orderRequestorDistrict string

Nome do bairro do enreceço.

orderRequestorCity string

Cidade do endereço.

orderRequestorState string

Estado (UF) do endereço.

orderRequestorCountryCode string

Código do país (ISO 3166).

orderRequestorRegistration string

Matrícula do solicitante

orderDepartment string

Departamento

orderCostCenterCode string

Código do centro de custo

orderCostCenterDescription string

Centro de custo

orderLedgerAccountCode string

Código da conta contábil

orderLedgerAccountDescription string

Descrição da conta contábil

orderProjectCode string

Código do projeto

orderProjectDescription string

Descrição do projeto

orderCustomField1 string

Campo customizado 1

orderCustomField2 string

Campo customizado 2

orderCustomField3 string

Campo customizado 3

orderCustomField4 string

Campo customizado 4

orderCustomField5 string

Campo customizado 5

Responses

200

VCN gerado com sucesso

application/json

Schema

Schema

echoToken string
vcnId string

Identificador do VCN. Utilizado para recuperar os dados do VCN a partir de Token e cancelamento do VCN.

vcnStatus string

Possible values: [VALID, CANCELLED]

Status do VCN

vcnDescription string

Descrição do VCN

creditCard object

Dados do VCN

cardTypeCode string

Bandeira do cartão de crédito

expireDate string

Data de expiração do cartão (formato MMAA)

cardHolderName string

Nome do portador do cartão

cardNumber string

Número do VCN gerado

cvv date

Código de segurança do cartão

Example (from schema)

{
  "echoToken": "string",
  "vcnId": "BAGABAG",
  "vcnStatus": "VALID",
  "vcnDescription": "string",
  "creditCard": {
    "cardTypeCode": "MASTERCARD",
    "expireDate": "0820",
    "cardHolderName": "Frank Castle",
    "cardNumber": "42424242908904",
    "cvv": "012"
  }
}

400

Estrutura da requisição inválida. Algum campo obrigatório faltante ou com tipo incorreto

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Forbidden"
}

missingParameters

Parâmetro obrigatório faltante.

{
  "error": "{'errorMessage': 'Invalid request. data must contain ['hotelReservationLocator', 'hotelReservationStartDate', 'hotelReservationEndDate', 'hotelVat', 'hotelPhone', 'hotelAddress', 'hotelCity', 'hotelCountryCode', 'hotelGuestFirstName', 'hotelGuestLastName', 'hotelName', 'hotelTotalPriceValue', 'hotelTotalPriceCurrencyCode', 'hotelTaxesTotalValue', 'hotelTaxesCurrencyCode'] properties'}"
}

multipleProducts

Mútiplos tipos de produto preenchidos.

{
  "error": "{ 'errorMessage' : 'Invalid request. Invalid product type. Must be one of: 'Hotel', 'Rental' or 'Flight'.'}"
}

401

Erro na autenticação - não foi enviado o token de autenticação.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Forbidden"
}

example

{
  "message": "Unauthorized"
}

403

Acesso negado - token de acesso inválido

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Forbidden"
}

example

{
  "message": "User is not authorized to access this resource with an explicit deny"
}

500

Erro geral. Pode ser erro de configuração de VCN, erro de comunicação com servidores externos.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Forbidden"
}

wrongCredentials

Erro de senha ou usuário no cadastro da credencial do VCN

{
  "message": "VCN: Cartão não gerado - A SENHA DO CONVÊNIO É INVÁLIDA"
}

errorWithVcnProvider

Erro durante a geração do VCN (ex: serviço fora do ar, URL inválida)

{
  "message": "VCN: Cartão não gerado - Erro inesperado."
}

errorWithVcnUDF

Erro de configuração da credencial VCN - exemplo, faltou configurar Ativação e Expiração

{
  "message": "VCN: Configuração inválida"
}

Loading...