Integração Deeplink SDK Único

O PaykitDeeplink é uma interface que permite a integração e comunicação com o SDK Único para processamento de pagamentos através de deeplinks.

Rota Base

Para chamar o PaykitDeeplink, a aplicação deve utilizar o seguinte formato de URL:

paykit://payment

Tipos de Operações

O parâmetro paymentType determina qual tipo de operação será executada:

Operação	Descrição
activate	Ativa o terminal
credit	Pagamento com cartão de crédito
debit	Pagamento com cartão de débito
voucher	Pagamento com voucher/vale
fleet	Pagamento com cartão de frota
pix	Pagamento via PIX
wallet	Pagamento via carteira digital
qrcode	Pagamento via QR Code
confirm	Confirma transação pendente
undo	Desfaz transação pendente
print_last_receipt	Imprime último recibo
get_transaction	Consulta detalhes de transação
cancel	Cancela transação
cancel_interactive	Cancelamento interativo
print	Imprime imagem
query_report	Consulta relatórios

Parâmetros por Método

1. Ativação

paykit://payment?paymentType=activate

Executar apenas 1 (uma) vez ou quando o terminal é realocado para outra loja.

Parâmetro	Descrição
activationCode	Código de ativação fornecido pelo provedor de pagamento
storeCnpj	CNPJ do estabelecimento comercial (sem máscara)
automationCnpj	CNPJ da automação (sem máscara)
isProduction	Indicador de ambiente de produção (true/false)
callbackUrl	URL de retorno após a operação

2. Crédito

paykit://payment?paymentType=credit

Parâmetro	Descrição
amount	Valor da transação em centavos
installments	Número de parcelas
creditType	Tipo de crédito (AT_SIGHT, STORE_INSTALMENTS, ISSUER_INSTALMENTS, PRE_AUTHORIZATION)
externalId	Identificador externo da transação
callbackUrl	URL de retorno após a operação

3. Débito

paykit://payment?paymentType=debit

Parâmetro	Descrição
amount	Valor da transação em centavos
debitType	Tipo de débito (AT_SIGHT, POSTDATED)
externalId	Identificador externo da transação
callbackUrl	URL de retorno após a operação

4. Voucher

paykit://payment?paymentType=voucher

Parâmetro	Descrição
amount	Valor da transação em centavos
voucherType	Tipo de voucher (FOOD, MEAL, AUTOMOTIVE, CULTURE, TOLL, BENEFITS)
externalId	Identificador externo da transação
callbackUrl	URL de retorno após a operação

5. PIX

paykit://payment?paymentType=pix

Parâmetro	Descrição
amount	Valor da transação em centavos
externalId	Identificador externo da transação
callbackUrl	URL de retorno após a operação

6. Cancelamento

paykit://payment?paymentType=cancel

Parâmetro	Descrição
transactionId	NSU da transação a ser cancelada
amount	Valor original da transação
cancelAmount	Valor a ser cancelado (para cancelamento parcial)
callbackUrl	URL de retorno após a operação

7. Consulta de Transação

paykit://payment?paymentType=get_transaction

Parâmetro	Descrição
transactionId	NSU da transação
externalId	ID externo da transação
callbackUrl	URL de retorno após a operação

8. Reimpressão

paykit://payment?paymentType=print_last_receipt

Parâmetro	Descrição
receiptType	Tipo de comprovante (MERCHANT, CUSTOMER)
callbackUrl	URL de retorno após a operação

Exemplos de Uso

Crédito à Vista

paykit://payment?paymentType=credit&amount=10000&creditType=AT_SIGHT&callbackUrl=myapp://callback

Crédito Parcelado (3x)

paykit://payment?paymentType=credit&amount=30000&installments=3&creditType=STORE_INSTALMENTS&callbackUrl=myapp://callback

Débito

paykit://payment?paymentType=debit&amount=5000&callbackUrl=myapp://callback

PIX

paykit://payment?paymentType=pix&amount=15000&callbackUrl=myapp://callback

Cancelamento

paykit://payment?paymentType=cancel&transactionId=123456&amount=10000&callbackUrl=myapp://callback

Retorno (Callback)

Após a operação, o SDK retorna para a URL especificada em callbackUrl com os seguintes parâmetros:

Parâmetro	Descrição
status	Status da transação (APPROVED, DECLINED, ERROR, CANCELLED)
transactionId	NSU da transação
externalId	ID externo (se informado)
amount	Valor da transação
message	Mensagem de retorno
rawData	Dados brutos da transação (JSON)