AME

Esta documentação descreve a integração com a carteira digital AME através do Carat, utilizando o roteamento CardSE via SiTef.

Informações cadastrais

O Carat deverá ser configurado para aceitar pagamentos para a Autorizadora AME via CardSe.

Pagamento REST

Fluxo

1. O lojista cria a transação no Carat passando algumas informações adicionais do AME e recebe o NIT como resposta.
2. A loja chama o serviço de efetivação de pagamento e recebe um QR code e a transação com status PEN (pendente).
3. A loja virtual exibe o QR code para o comprador.
4. O comprador escaneia o QR code com o aplicativo AME e passa pelo procedimento de confirmação do pagamento solicitado pelo autorizador.
5. Enquanto o comprador finaliza o pagamento, o Carat sondará a situação da compra no autorizador até que a transação se encerre.
6. A loja, por sua vez, deve consultar o status da transação do Carat até que ela saia do status PEN.

Atenção:

Se o status da transação permanecer pendente (PEN) após aproximadamente 3 (três) minutos, o Carat irá desfazer a transação junto à AME.

Informações adicionais na criação da transação

Para transações com AME, deve ser utilizado authorizer_id = 446.

Abaixo estão parâmetros adicionais que podem ser enviados em transações AME:

Parâmetro	Descrição	Formato	Obrigatório
additional_data.items[]
ean	Código EAN do produto. Atenção: caso o EAN e o SKU sejam enviados simultaneamente, apenas o EAN será considerado.	< 255 AN	NÃO
sku	Código SKU do produto. Atenção: caso o EAN e o SKU sejam enviados simultaneamente, apenas o EAN será considerado.	< 255 AN	NÃO
description	Descrição do produto.	< 30 AN	NÃO
quantity	Quantidade do produto a ser adquirido.	< 15 N	NÃO
quantity_type	Tipo da quantidade: u - Unidades g - Gramas ml - Mililitros	< 2 AN	NÃO
unit_price	Preço unitário do produto em centavos.	< 12 N	NÃO

Exemplo

Iniciando a transação

--request POST "https://{{url}}/e-sitef/api/v1/transactions"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-raw '

{

"merchant_usn":"12042142155",

"order_id":"1651001767957",

"installments":"1",

"installment_type":"4",

"authorizer_id":"446",

"amount":"1000",

"additional_data": {

"items": [

{

"quantity": "1",

"quantity_type": "u",

"unit_price": "50000",

"ean": "9283746529385",

"description": "bola para jogar 1"

},

{

"quantity": "2",

"quantity_type": "u",

"unit_price": "25000",

"ean": "9283746529384",

"description": "bola para jogar 2"

}

]

}

}'

Requisição da efetivação do pagamento

Na integração com AME, não será necessário o envio de nenhum dado do cartão.

Exemplo:

--request POST "https://{{url}}/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-raw '

{

}'

Retornos na efetivação do pagamento com tamanho diferente do padrão

Parâmetro	Descrição	Formato
authorization_number	Número de autorização.	< 100 AN

Atenção:

Em caso de erro de comunicação nesta operação, será necessário criar outra transação.

Exemplo:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"authorizer_code": "000",

"status": "PEN",

"nit": "a479f7d0fc3e3bdfe22f489298b9ca56fa98c4c7c56e2529eb4fddb44c7a392c",

"order_id": "1651003189064",

"authorizer_id": "446",

"acquirer_id": "271",

"acquirer_name": "CardSE",

"authorizer_date": "26/04/2022T16:59",

"authorization_number": "111111111122222222223333333333444444444455555555556666666666 ",

"merchant_usn": "12042142155",

"esitef_usn": "220426096883310",

"sitef_usn": "265428",

"host_usn": "000000000 ",

"amount": "1000",

"payment_type": "O",

"authorizer_merchant_id": "084675745000140",

"terminal_id": "ES000041",

"payment_date": "26/04/2022T16:59",

"qr_code": "The quick brown fox jumps over the lazy dog"

}

}

Pagamento HTML

Não há diferenças no fluxo para a loja.

Assim como no Pagamento REST, podem ser enviados parâmetros adicionais na criação da transação, usando o mesmo formato.

Cancelamento REST

Requisição da efetivação do cancelamento

Na integração com AME, não será necessário o envio de nenhum dado do cartão.

Exemplo:

--request PUT "https://{{url}}/e-sitef/api/v1/cancellations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-raw '{

}'

Retorno na efetivação do cancelamento

{

"code": "0",

"message": "OK. Transaction successful.",

"cancellation": {

"authorizer_code": "000",

"authorizer_message": "Lojista OK",

"status": "CON",

"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",

"order_id": "1651003189064",

"customer_receipt": "=== COMPROVANTE ===",

"merchant_receipt": "=== COMPROVANTE ===",

"authorizer_id": "446",

"acquirer_id": "1271",

"acquirer_name": "CardSE",

"authorizer_date": "26/04/2022T17:12",

"authorization_number": "265429",

"merchant_usn": "12042142155",

"esitef_usn": "220426096883331",

"sitef_usn": "265429",

"host_usn": "00000000000004265429 ",

"amount": "1000",

"payment_type": "O",

"authorizer_merchant_id": "084675745000140",

"esitef_date": "26/04/2022T17:12",

"is_host_cancel": "false"

}

}

Geração de link de pagamento no Portal do Lojista

Também é possível fazer pagamentos com AME através de funcionalidade de link de pagamento do Portal Lojista. No entanto, ainda não está disponível a possibilidade do envio das informações adicionais do AME.