API Reference

Realizar cobrança com autenticação bancária

Realizar cobrança com autenticação bancária

Esta API realiza a autorização e aprovação da transação e retorna as telas de
sucesso ou falha.

{
 "amount": 5,
 "reference": "jlh1oRRzdfxC6Vhh",
 "card_token": "G86aB2R1X3aCSZXKf362UI0op00000",
 "client_name": "Maria Camila Soares",
 "client_email": "[email protected]",
 "client_phone": "85999001122",
 "installments": 1,
 "brand": "mastercard",
 "cpf_cnpj_holder": "77495197005",
 "partner_token_api": "TOKEN API DO PARCEIRO AQUI",
  "threedsecure": {
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS
X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/124.0.0.0 Safari/537.36",
"ipAddress": "0.0.0.0",
"device": {
"colorDepth": 24,
"screenHeight": 896,
"screenWidth": 414
}
},
"url_success":
"https://gateway.fixpay.com.br/v1/safelink/success",
"url_failure":
"https://gateway.fixpay.com.br/v1/safelink/failure",
"wpp_number":"8599001122",
"product": "TESTE"
 }

Observação:

● O campo "reference" deve ser preenchido com uma sequência única de 16
caracteres para cada transação. O valor não pode ser repetido e deve ser
gerado e preenchido de acordo com o controle interno do estabelecimento para
identificação das cobranças.
● Em threedsecure, informe o "useragent", "ipAddress" do dispositivo gerador da cobrança.
● Em "device" os campos: "colorDepth", "screenHeight" e "screenWidth" devem ser preenchidos com as dimensões do dispositivo, conforme especificações do sistema da empresa.

Exemplo de retorno da requisição:

{
 "data": {
 "dateTime": "2025-04-10T10:34:07-03:00",
 "threeDSecure": {
 "embedded": true,
 "url":
"https://gateway.fixpay.com.br/pc/l/8599001122/0gaXoMF8
jIit1kJiC2eBUkciyC2ATyxlVCl6"
 },
 "returnCode": "220",
 "returnMessage": "Transaction request with
authentication received. Redirect URL sent."
 },
 "reference": "jlh1oRRzdfxC6hhh"
}

Observação: O parâmetro “url” que retorna nesta requisição direciona para a
tela de desafio da autenticação bancária.

Exemplo de tela de falha e sucesso na validação da cobrança:


É necessário passar o Token API do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor do conteúdo que está sendo enviado, neste caso usamos "application/json".

Abaixo temos um exemplo de como inserir estes dados usando JSON.

Language
Click Try It! to start a request and see the response here!