Facilitador de Pagamento

Visão Geral#

Neste item serão apresentadas características para roteamento de transações no Facilitador de Pagamentos via adquirência processadas pela Fiserv.

Atenção: Para operar como Facilitador de Pagamentos, será necessário ter PFAC id com as bandeiras , assinar contrato com a adquirência e solicitar acesso ao ambiente especifico para testes .

Estabelecimentos que operam como Facilitador de Pagamento intermediam outros estabelecimentos (submerchants) para a aceitação de pagamentos eletrônicos na adquirente. Para operar nesta modalidade, será necessário solicitar configuração no cadastro e trafegar informações especificas das operações de seus submerchants conforme instruções:

Pagamento#

Recurso: /e-sitef/api/v2/payments/
Método HTTP: POST
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplos#

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

Requisição:

curl --location 'https://{{url}}/e-sitef/api/v2/payments/' 
--header 'Content-Type: application/json' 
--header 'merchant_id: xxxxxxxxx' 
--header 'merchant_key: xxxxxxxxxxxxxx' 
--data '{
    "merchant_usn": "123456789",
    "order_id": "2222",
    "installments": "1",
    "installment_type": "4",
    "authorizer_id": "002",
    "amount": "15011",
    "soft_descriptor": "Empresa Aluguel de carros XYZ",
    "card": {
        "expiry_date": "1225",
        "security_code": "123",
        "number": "XXXXXXXXXXXXXXXX",
        "holder": "holder"
    },
    "additional_data": {
        "mcc": "9876",
        "subacquirer_merchant": {
            "id": "id subseller",
            "address": "address",
            "city": "city",
            "state": "state",
            "country": "BRA",
            "zip_code": "01307001",
            "identification_number": "965551550001639999",
            "payment_facilitator_id": "12345678901",
            "payment_facilitator_url": "www.payment_facilitator_url.request.com",
            "phone_number": "12344321"
        }
    }
}'

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de criação de transações:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_usn`	Número sequencial único para cada pedido, criado pela loja. O NSU será utilizado em toda a comunicação com a loja, de forma a identificar o pedido. Como se trata de uma possível chave para acesso do lado da loja, apesar de ser opcional para o Carat, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.	< 12 N	NÃO
`order_id`	Código do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade.	< 40 AN	NÃO
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento: valor 3 = parcelamento com juros da administradora do cartão. valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista). Valor 6 = parcelamento com juros da administradora (IATA). valor 7 = parcelamento realizado pela loja e sem juros (IATA). O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 3 N	NÃO
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 25 AN	SIM
card	Dados do cartão.
`expiry_date`	Data de vencimento do cartão no formato MMAA.	< = 4 N	COND.
`security_code`	Código de segurança.	< < 5 N	COND.
`number`	Número do cartão do comprador (PAN).	< 5 T/F	NÃO
`holder`	Nome do comprador	< 40 AN	SIM
additional_data	Elemento para envio de dados adicionais.
`mcc`	Código de comércio (Merchant Category Code)	< = 4 N	Sim
*subacquirer_merchant*	Dados comerciante subadquirente
`id`	Código do subseller (Pode ser o CNPJ ou qualquer outro código único)	= 15 N	Sim
`address`	Endereço do subseller	< 120 AN	Sim
`city`	Cidade	< 20 AN	Sim
`state`	UF	< 30 AN	Sim
`country`	País segundo código numérico da ISO 3166	< 3 N	Sim
`zip_code`	CEP	< 8 N	Sim
`identification_number`	CNPJ do subseller	< 18 N	Sim
`payment_facilitator_id`	Id facilitador do pagamento (Se não chegar em 11 caracteres, complementar com zeros a esquerda)	= 11 N	Sim
`payment_facilitator_url`	Url facilitador do pagamento	< 76 AN	Sim
`phone_number`	Número de telefone	< 15 N	Sim

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "authorizer_code": "000",
    "authorizer_message": "APROVADA 032002400",
    "status": "CON",
    "nit": "37117091450fe1046a3a2187a7dc25334b4976e69e222ee8123247692acc3c45",
    "order_id": "2222",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "229",
    "acquirer_name": "Bin (Via Servicos TEF)",
    "authorizer_date": "03/07/2024T16:01",
    "authorization_number": "AG4320",
    "merchant_usn": "123456789",
    "esitef_usn": "240703136024660",
    "sitef_usn": "000001",
    "host_usn": "032002400",
    "amount": "15011",
    "payment_type": "C",
    "terminal_id": "ES000001",
    "payment_date": "03/07/2024T16:01"
  }
}

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 201. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de criação de transações:

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
payment
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no Carat. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no Carat.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 4 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`esitef_usn`	Número sequencial único da transação de pagamento no Carat.	= 15 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`host_usn`	NSU da autorizadora. Ressalva para efetivação de pagamentos PIX	< 15 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 AN
`terminal_id`	Código do terminal utilizada na transação	< 8 N
`payment_date`	Data de efetivação do pagamento no Carat no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D

Pré-Autorização#

Recurso: /e-sitef/api/v2/preauthorizations/
Método HTTP: POST
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplo#

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

Requisição:

curl --location 'https://{{url}}/e-sitef/api/v2/preauthorizations/' 
--header 'Content-Type: application/json' 
--header 'merchant_id: xxxxxxxxx' 
--header 'merchant_key: xxxxxxxxxxxxxx' 
--data '{
    "merchant_usn": "123456789",
    "order_id": "2222",
    "installments": "1",
    "installment_type": "4",
    "authorizer_id": "002",
    "amount": "15011",
    "soft_descriptor": "Empresa Aluguel de carros XYZ",
    "card": {
        "expiry_date": "1225",
        "security_code": "123",
        "number": "XXXXXXXXXXXXXXXX",
        "holder": "holder"
    },
    "additional_data": {
        "mcc": "9876",
        "subacquirer_merchant": {
            "id": "id subseller",
            "address": "address",
            "city": "city",
            "state": "state",
            "country": "BRA",
            "zip_code": "01307001",
            "identification_number": "965551550001639999",
            "payment_facilitator_id": "12345678901",
            "payment_facilitator_url": "www.payment_facilitator_url.request.com",
            "phone_number": "12344321"
            
        }
    },
    "subacquirer_merchant_id": "ad.subacquirer_merchant.id"
}'

Parâmetros de requisição

Parâmetro	Descrição	Formato	Obrigatório
`merchant_usn`	Número sequencial único para cada pedido, criado pela loja. O NSU será utilizado em toda a comunicação com a loja, de forma a identificar o pedido. Como se trata de uma possível chave para acesso do lado da loja, apesar de ser opcional para o Carat, é fortemente recomendado que o campo seja formatado e enviado pela aplicação da loja.	< 12 N	NÃO
`order_id`	Código do pedido para ser exibido ao comprador, definido pelo lojista. É aconselhável que seja diferente a cada pedido para que facilite a rastreabilidade.	< 40 AN	NÃO
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento: valor 3 = parcelamento com juros da administradora do cartão. valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista). Valor 6 = parcelamento com juros da administradora (IATA). valor 7 = parcelamento realizado pela loja e sem juros (IATA). O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 3 N	NÃO
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 25 AN	SIM
card	Dados do cartão.
`expiry_date`	Data de vencimento do cartão no formato MMAA.	< = 4 N	COND.
`security_code`	Código de segurança.	< < 5 N	COND.
`number`	Número do cartão do comprador (PAN).	< 5 T/F	NÃO
`holder`	Nome do comprador	< 40 AN	SIM
additional_data	Elemento para envio de dados adicionais.
`mcc`	Código de comércio (Merchant Category Code)	< = 4 N	Sim
*subacquirer_merchant*	Dados comerciante subadquirente
`id`	Código do subseller (Pode ser o CNPJ ou qualquer outro código único)	= 15 N	Sim
`address`	Endereço do subseller	< 120 AN	Sim
`city`	Cidade	< 20 AN	Sim
`state`	UF	< 30 AN	Sim
`country`	País segundo código numérico da ISO 3166	< 3 N	Sim
`zip_code`	CEP	< 8 N	Sim
`identification_number`	CNPJ do subseller	< 18 N	Sim
`payment_facilitator_id`	Id facilitador do pagamento (Se não chegar em 11 caracteres, complementar com zeros a esquerda)	= 11 N	Sim
`payment_facilitator_url`	Url facilitador do pagamento	< 76 AN	Sim
`phone_number`	Número de telefone	< 15 N	Sim

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "pre_authorization": {
    "authorizer_code": "000",
    "authorizer_message": "APROVADA 032002401",
    "status": "CON",
    "nit": "091dcbfddb12db09867ac16a9f96a44a6a2d904816b5cab88da61f141ed30dbe",
    "order_id": "2222",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "2651",
    "acquirer_name": "Bin (Via Servicos TEF)",
    "authorizer_date": "03/07/2024T16:02",
    "authorization_number": "AG9729",
    "merchant_usn": "123456789",
    "esitef_usn": "240703136024674",
    "sitef_usn": "000002",
    "host_usn": "032002401",
    "amount": "2000",
    "payment_type": "C",
    "terminal_id": "ES000001"
  }
}

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
pre_authorization
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`status`	Status da transação de pagamento no Carat. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no Carat.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 12 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`esitef_usn`	Número sequencial único da transação de pagamento no Carat.	= 15 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`host_usn`	NSU da autorizadora. Ressalva para efetivação de pagamentos PIX	< 15 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 AN
`terminal_id`	Código do terminal utilizada na transação	< 8 N
`payment_date`	Data de efetivação do pagamento no Carat no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D

Captura#

Recurso: /e-sitef/api/v1/preauthorizations/capture/{{nit}}
Método HTTP: POST
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplos#

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

Requisição:

curl --location 'https://{{url}}/e-sitef/api/v1/preauthorizations/capture/{{nit}}' 
--header 'Content-Type: application/json' 
--header 'merchant_id: xxxxxxxxx' 
--header 'merchant_key: xxxxxxxxxxxxxx' 
--data '{       
    "amount": "1200",
    "installments": "1",
    "installment_type": "4",
        "soft_descriptor": "Empresa Aluguel de carros XYZ",
        "mcc":"9333",
        "subacquirer_merchant" : {
            "id": "id subseller",
            "address" : "123RUA DA AVENIDA SOFTWAREEXPRESS 123",
            "city" : "mogi das cruzes",
            "state" : "SSA",
            "country" : "BRA",
            "zip_code" : "01307001",
            "identification_number" : "96555155000163",
            "payment_facilitator_id" : "12345678901",
            "payment_facilitator_url" : "www.payment_facilitator_url.request.com",
            "phone_number": "12344321",
            "mcc": "1234"
             
    }
}'

Parâmetros de requisição

Parâmetro	Descrição	Formato	Obrigatório
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`installments`	Número de parcelas. Envie ‘1’ para transações à vista.	< 2 N	SIM
`installment_type`	Tipo de financiamento do parcelamento: valor 3 = parcelamento com juros da administradora do cartão. valor 4 = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista). Valor 6 = parcelamento com juros da administradora (IATA). valor 7 = parcelamento realizado pela loja e sem juros (IATA). O parcelamento IATA é utilizado somente por empresas do seguimento de transporte aéreo.	< 2 N	SIM
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 25 AN	SIM
*subacquirer_merchant*	Dados comerciante subadquirente
`id`	Código do subseller (Pode ser o CNPJ ou qualquer outro código único)	= 15 N	Sim
`address`	Endereço do subseller	< 120 AN	Sim
`city`	Cidade	< 20 AN	Sim
`state`	UF	< 30 AN	Sim
`country`	País segundo código numérico da ISO 3166	< 3 N	Sim
`zip_code`	CEP	< 8 N	Sim
`identification_number`	CNPJ do subseller	< 18 N	Sim
`payment_facilitator_id`	Id facilitador do pagamento (Se não chegar em 11 caracteres, complementar com zeros a esquerda)	= 11 N	Sim
`payment_facilitator_url`	Url facilitador do pagamento	< 76 AN	Sim
`phone_number`	Número de telefone	< 15 N	Sim
`mcc`	Código de comércio (Merchant Category Code)	< = 4 N	Sim

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "card": {
    "suffix": "8589",
    "bin": "548573"
  },
  "capture": {
    "authorizer_code": "000",
    "authorizer_message": "APROVADA 032002402",
    "status": "CON",
    "nit": "86dabba4d4c22b7ac69ef7787d95a9b447a3ff6ebf04f5685097bbf568ffb098",
    "order_id": "2222",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "2651",
    "acquirer_name": "Bin (Via Servicos TEF)",
    "authorizer_date": "03/07/2024T16:03",
    "authorization_number": "AG9729",
    "merchant_usn": "123456789",
    "esitef_usn": "240703136024684",
    "sitef_usn": "000003",
    "host_usn": "032002402",
    "amount": "1200",
    "payment_type": "C",
    "issuer": "0"
  }
}

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
capture
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no Carat. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no Carat.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 12 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`esitef_usn`	Número sequencial único da transação de pagamento no Carat.	= 15 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`host_usn`	NSU da autorizadora. Ressalva para efetivação de pagamentos PIX	< 15 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 AN

Cancelamento#

O processo de cancelamento exige autenticação com assinatura por padrão, ver detalhes em Pagamento Online | Cancelamento e seguir a chamada abaixo. OBS: Para transações já capturadas também será possível usar o Cancelamento Assincrono, ver detalhes em Pagamento Online | Cancelamento Assíncrono

Recurso: e-sitef/api/v2/cancellations/{{nit}}
Método HTTP: POST
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no Carat. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM
`Authorization`	Deve ser enviada a assinatura de autenticação da loja no formato `Bearer {assinatura}`. Exemplo: `Bearer JHVGytfdgauygdauiw78264284527852897hagdg`. Este campo é obrigatório, a não ser que a loja esteja configurada para se comunicar com autenticação mútua (mTLS) junto ao Carat.	< 2000 AN	COND.

Exemplos#

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

Requisição:

curl --location 'https://{{url}}/e-sitef/api/v2/cancellations/{{nit}}' 
--header 'Content-Type: application/json' 
--header 'merchant_id: xxxxxxxxx' 
--header 'merchant_key: xxxxxxxxxxxxxx' 
--header 'Authorization: Bearer {assinatura}' 
--data '{
    "amount": "1200",
    "mcc":"9444",
        "subacquirer_merchant" : {
            "id": "id subseller",
            "address" : "123RUA DA AVENIDA SOFTWAREEXPRESS 123",
            "city" : "mogi das cruzes",
            "state" : "SSA",
            "country" : "BRA",
            "zip_code" : "01307001",
            "identification_number" : "96555155000163",
            "payment_facilitator_id" : "12345678901",
            "payment_facilitator_url" : "www.payment_facilitator_url.request.com",
            "phone_number": "12344321"
             
    }
}'

Parâmetros de requisição

Parâmetro	Descrição	Formato	Obrigatório
`amount`	Valor total da compra (em centavos). Exemplo: 1,00 = 100 ou 1.100,00 = 110000 – enviar o valor sem a vírgula e ponto.	< 12 N	SIM
`mcc`	Código de comércio (Merchant Category Code)	< = 4 N	Sim
*subacquirer_merchant*	Dados comerciante subadquirente
`id`	Código do subseller (Pode ser o CNPJ ou qualquer outro código único)	= 15 N	Sim
`address`	Endereço do subseller	< 120 AN	Sim
`city`	Cidade	< 20 AN	Sim
`state`	UF	< 30 AN	Sim
`country`	País segundo código numérico da ISO 3166	< 3 N	Sim
`zip_code`	CEP	< 8 N	Sim
`identification_number`	CNPJ do subseller	< 18 N	Sim
`payment_facilitator_id`	Id facilitador do pagamento (Se não chegar em 11 caracteres, complementar com zeros a esquerda)	= 11 N	Sim
`payment_facilitator_url`	Url facilitador do pagamento	< 76 AN	Sim
`phone_number`	Número de telefone	< 15 N	Sim

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "cancellation": {
    "authorizer_code": "000",
    "authorizer_message": "APROVADA 032002404",
    "status": "CON",
    "nit": "8907c3dd7419ecd654378fecc02ae70bfbc3a1a54faf26603b9124f9f7687d77",
    "order_id": "2222",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "2651",
    "acquirer_name": "Bin (Via Servicos TEF)",
    "authorizer_date": "03/07/2024T16:03",
    "authorization_number": "AG4692",
    "merchant_usn": "123456789",
    "esitef_usn": "240703136034691",
    "sitef_usn": "000005",
    "host_usn": "032002404",
    "amount": "1500",
    "payment_type": "C",
    "esitef_date": "03/07/2024T16:03",
    "is_host_cancel": "false"
  }
}

Parâmetros de resposta

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
cancellation
`authorizer_code`	Código de resposta do autorizador.	< 10 AN
`authorizer_message`	Mensagem de resposta do autorizador.	< 500 AN
`status`	Status da transação de pagamento no Carat. Saiba mais.	= 3 AN
`nit`	Identificador da transação de pagamento no Carat.	= 64 AN
`order_id`	Código de pedido enviado pela loja na criação da transação.	< 40 AN
`customer_receipt`	Cupom (via cliente).	< 4000 AN
`merchant_receipt`	Cupom (via estabelecimento).	< 4000 AN
`authorizer_id`	Código da autorizadora no Carat. Saiba mais.	< 12 N
`acquirer_id`	Código do adquirente utilizado na transação.	< 4 N
`acquirer_name`	Nome do adquirente utilizado na transação.	< 100 AN
`authorizer_date`	Data de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`authorization_number`	Número de autorização.	< 6 AN
`merchant_usn`	Número sequencial único enviado pela loja na criação da transação.	< 12 N
`esitef_usn`	Número sequencial único da transação de pagamento no Carat.	= 15 N
`sitef_usn`	Número sequencial único da transação de pagamento no SiTef.	= 6 N
`host_usn`	NSU da autorizadora. Ressalva para efetivação de pagamentos PIX	< 15 AN
`amount`	Valor da compra especificado pela loja (em centavos) na criação da transação.	< 12 N
`payment_type`	Tipo do pagamento da autorizadora escolhida: B = boleto, C = crédito, D = débito, P = cartão crédito Private Label puro, T = tranferência bancária, G = cartão gift, O = outros meios de pagamentos, W = Boleto NR via Web Service	= 1 AN
`esitef_date`	Data de efetivação do cancelamento no Carat no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03	= 16 D
`is_host_cancel`	Este campo retornará o valor true em caso de cancelamento via host.	< 5 T/F

Home

Visão Geral#

Pagamento#

Exemplos#

Pré-Autorização#

Exemplo#

Captura#

Exemplos#

Cancelamento#

Exemplos#