Serviço de criação da transação

O consumo desse serviço é obrigatório no fluxo de pagamento JavaScript. Adicionalmente aos parâmetros de requisição de pagamento REST, também devem ser enviados os seguintes parâmetros:

Parâmetro	Descrição	Formato	Obrigatório
`payment_js`	Deve ser enviado com o valor `true` para habilitar o fluxo de pagamento JavaScript.	< 5 A	SIM
`authenticate`	Identifica o tipo de autenticação 3DS 2.0. `1` = Habilitar o uso de 3DS. Mas, se o 3DS server não suporta a bandeira ou falhe para realizar a autenticação, o pagamento será negado. `2` = Habilitar o uso de 3DS. Porém, se o 3DS server não suporta a bandeira, não faz autenticação com 3DS server. Se a bandeira for suportada e a autenticação negar, o pagamento será negado `3` = Habilitar o uso de 3DS. Entretanto, mesmo se a autenticação falhar, o pagamento não será negado na autenticação, com exceção para casos onde usuário cancele ou abandone o desafio antes de ser finalizado.	= 1 N	SIM
`additional_data`	Dados gerais da transação.
`exponent`	Número de casas decimais da moeda conforme definido na ISO 4217. O valor default será `2`.	= 1 N	NÃO
`extra_info`	Informações adicionais sobre a conta fornecidas opcionalmente pelo 3DS Requestor.	< 64 AN	NÃO
`additional_data` `.payer`	Informações do portador do cartão.
`email`	Endereço de email do portador. É recomendável enviar esse campo, pois ajuda na avaliação de risco contribuindo para uma autenticação frictionless.	< 256 AN	NÃO
`name`	Nome do portador.	< 45 AN	NÃO
`additional_data` `.payer` `.phones[]`	Informações do telefone do portador do cartão.
`ddi`	DDI do telefone. É recomendável enviar esse campo, pois ajuda na avaliação de risco contribuindo para uma autenticação frictionless.	< 3 N	NÃO
`ddd`	DDD do telefone. É recomendável enviar esse campo, pois ajuda na avaliação de risco contribuindo para uma autenticação frictionless.	< 3 N	NÃO
`number`	Número do telefone. É recomendável enviar esse campo, pois ajuda na avaliação de risco contribuindo para uma autenticação frictionless.	< 12 N	NÃO
`type`	Tipo do telefone: `1`: residencial (fixo) `2`: comercial `6`: celular Quando não enviado atribui-se valor padrão: `06` É recomendável enviar esse campo, pois ajuda na avaliação de risco contribuindo para uma autenticação frictionless.	< 12 N	NÃO
`additional_data` `.billing_data` `.address`	Endereço de cobrança.
`city`	Cidade.	< 50 AN	NÃO
`country`	Código numérico ISO 3166-1 de três dígitos do país.	= 3 N	NÃO
`street_name`	Nome da rua.	< 50 AN	NÃO
`street_number`	Número da rua.	< 50 AN	NÃO
`complement`	Complemento do endereço.	< 50 AN	NÃO
`zip_code`	CEP.	< 16 AN	NÃO
`state`	Sigla do estado.	< 3 AN	NÃO
`additional_data` `.shipment` `.address`	Endereço de entrega.
`city`	Cidade.	< 50 AN	NÃO
`country`	Código numérico ISO 3166-1 de três dígitos do país.	= 3 N	NÃO
`street_name`	Nome da rua.	< 50 AN	NÃO
`street_number`	Número da rua.	< 50 AN	NÃO
`complement`	Complemento do endereço.	< 50 AN	NÃO
`zip_code`	CEP.	< 16 AN	NÃO
`state`	Sigla do estado.	< 3 AN	NÃO

Como resposta, o seguinte parâmetro será adicionalmente retornado:

Parâmetro	Descrição	Formato
payment
`pay_token`	Token associado ao pagamento JavaScript.	= 66 AN

Para mais detalhes sobre essa chamada, consulte Pagamento REST.

Exemplo#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxx"
--data-binary
{
    "authenticate": "1",
    "merchant_usn":"12042142155",
    "order_id":"12042142155",
    "installments":"1",
    "installment_type":"4",
    "authorizer_id":"2",
    "amount":"10004",
    "payment_js":"true"
}
--verbose

Resposta:

{
    "code":"0",
    "message":"OK. Transaction successful.",
    "payment":{
        "status":"NOV",
        "nit":"1234567890123456789012345678901234567890123456789012345678901234",
        "order_id":"12042142155",
        "merchant_usn":"12042142155",
        "amount":"1000",
        "pay_token":"123456789012345678901234567890123456789012345678901234567890123456"
    }
}

Home

Exemplo#