Login

Classe responsável pela autenticação e controle de senha do usuário no sistema

APIDescription
POST login

Método que faz autenticação do usuário no backoffice e aplicativo
POST senha/esqueci

Método que dispara e-mail para recuperar a senha do usuário
PUT senha/alterar

Método para alterar a senha de um usuário logado

Classe responsável pelos dados de Menu do app

APIDescription
GET menu/lista

Método responsável por listar o menu para exibição no app

Parceiro

Classe responsável pelos dados de Menu do app

APIDescription
GET parceiros?categoria={categoria}

Método responsável por listar os parceiros disponíveis

Cartao

Classe responsável pelos dados e ações de Cartão no sistema

APIDescription
GET cartao/saldobeneficios

Método responsável para buscar saldo do cartão do colaborador
GET cartao/saldo

Método responsável para buscar saldo do cartão do colaborador
GET cartao/bloqueado

Método responsável para buscar os cartões bloqueados do colaborador
GET cartao/lista

Método responsável para buscar todos os cartões colaborador na Swap
GET cartao/extrato?di={di}&dt={dt}

Método responsável por buscar extrato do cartão do colaborador
GET cartao/bloqueio

Método responsável para bloquear cartao
PUT cartao/bloqueio/especifico

Método responsável para bloquear cartao
GET cartao/desbloqueio

Método responsável para desbloquear o cartao
PUT cartao/desbloqueio/especifico

Método responsável para desbloquear o cartao
POST cartao/integrar

Método responsável para integrar o cartão
POST cartao/resetar_pin

Método responsável para criar e resetar pin
GET cartao/extrato-v2?di={di}&dt={dt}

Método responsável por buscar extrato v2 do colaborador na SWAP

Colaborador

Classe responsável pelos dados e ações de Colaboradores no sistema

APIDescription
POST colaborador/integrar

Método responsável para integrar o colaborador
GET colaborador/beneficio

Método responsável por listar os benefícios do colaborador
POST colaborador/cpf_ativar

Método responsável para ativar cpf
POST colaborador/IntegrarPushNotification

No documentation available.

FaleConosco

Classe responsável pelos dados e ações do FaleConosco do app

APIDescription
POST faleconosco/inserir

Método para inserir fale conosco.

Classe responsável pelos dados de Banners no sistema

APIDescription
GET banner/lista

Método responsável por listar banner para exibição
POST banner/click

Método responsável por contabilizar o click no banner

Transferencia

Classe responsável pelos dados e ações de transferencia no sistema

APIDescription
POST transferencia/colaboradores

Método responsável para transferir valores

Mensagem

Classe responsável por exibir a listagem e detalhes de mensagens urgentes

APIDescription
GET mensagem/lista

Exibe uma lista com todas as mensagens urgentes disponíveis
PUT mensagem/update

No documentation available.

TotalExpress

Classe responsável pelos dados de integração com a TotalExpress

APIDescription
POST totalexpress/integrar

Método responsável para buscar saldo do cartão do colaborador

Webhook

Classe responsável pelos dados de integração

APIDescription
POST webhook/swap/transacao

Recebe dados de integração
POST webhook/swap/transacao_pix

Recebe dados de integração
POST webhook/swap/kyc_analysis_updated

Recebe dados de integração
POST webhook/swap/bag_status_updated

Recebe dados de integração
POST webhook/swap/cards_transaction_txn_authorization

Recebe dados de integração
POST webhook/swap/cards_transaction_funds_create

Recebe dados de integração
POST webhook/swap/cards_transaction_txn_internal_transfer

Recebe dados de integração
POST webhook/swap/cards_transaction_expiry

Recebe dados de integração
POST webhook/swap/cards_clearing_credit

Recebe dados de integração
POST webhook/swap/cards_clearing_debit

Recebe dados de integração
POST webhook/swap/funds_manager_transfer_failed

Recebe dados de integração
POST webhook/swap/Cards_Transaction_V2_Txn_authorization

Online operations processed will be notified through this event. Online transactions are represented by operations with:
POST webhook/swap/Cards_Transaction_V2_Account_status

Account Status are transactions that validate account status. When you register the card on a website, the website can check if the account is active. It has no financial impact on the account.
POST webhook/swap/Cards_Transaction_V2_Balance_inquiry

Balance inquiry are transactions that validate the balance of the account, during a withdraw. It has no financial impact on the account.
POST webhook/swap/Cards_Transaction_V2_Expiry

If an authorized transaction is not confirmed (cleared) by the acquirer in 30 days, the transaction will expire and the amount will be added back to the account available funds. An expiry message will be defined by the following fields:
POST webhook/swap/Cards_Transaction_V2_Txn_internal_transfer

It has all transfers between the accounts within your Swap arrangement, in all hierarchy level account.
POST webhook/swap/Cards_Clearing_V2_Debit

A clearing debit event will be generated anytime a transaction is confirmed by the acquirer during the clearing processing.
POST webhook/swap/Cards_Clearing_V2_Credit

A clearing credit event will be generated anytime a transaction is offline reversed by the acquirer during the clearing processing. The return amount will be added back to the account available funds. A credit clearing message will be defined by the following fields:
POST webhook/swap/Ted_Status_Update

A ted.status.update will be sent anytime a Bank Transfer is sent and the status is updated.
POST webhook/swap/Boleto_out_Update

A boleto_out.update will be sent anytime a boleto is refunded/rollbacked to your account.
POST webhook/swap/Pix_out_Update

Update of the final PIX status. This update will be sent for any type of PIX (full data, key or QRcode).
POST webhook/swap/Pix_in_Update

You will be notified anytime a PIX is successfully credited in a Banking account.
POST webhook/swap/Pix_reversal_in_Update

You will be notified anytime a PIX Reversal is successfully credited in a Banking account.
POST webhook/swap/Boleto_in_Update

You will be notified anytime a Boleto Billing has a status update.

Pix

Classe responsável pelos dados e ações de pix

APIDescription
GET pix/contatos

Método responsável por listar bancos
GET pix/bancos?busca={busca}

Método responsável por listar bancos
POST pix/chave

Método responsável para transferir valores pix
PUT pix/chave-confirmar?IDTransferenciaPix={IDTransferenciaPix}&salvarContato={salvarContato}

Método responsável para transferir valores pix
POST pix/qrcode

Método responsável para transferir valores pix
PUT pix/qrcode-confirmar?IDTransferenciaPix={IDTransferenciaPix}

Método responsável para transferir valores pix
PUT pix/qrcode-confirmar-com-valor?IDTransferenciaPix={IDTransferenciaPix}&valor={valor}

Método responsável para transferir valores pix
POST pix/dadosbancarios

Método responsável para transferir valores pix
GET pix/saldo

Método responsável para buscar saldo do cartão do colaborador
GET pix/extrato

Método responsável para buscar saldo do cartão do colaborador