# Api Expert ## Docs - Documentos [Rakim Expert ](https://api-doc.rakim.com.br/rakim-expert-6710462f0.md): O objetivo desta documentação é orientar o desenvolvedor sobre as especificações das API's, descrevendo funcionalidades e métodos, listando informações que devem ser enviadas e recebidas nas requisições como também provendo exemplos. - Documentos [Homologação](https://api-doc.rakim.com.br/homologa%C3%A7%C3%A3o-6710473f0.md): oi - Documentos > Homologação [Processo de Homologação](https://api-doc.rakim.com.br/processo-de-homologa%C3%A7%C3%A3o-6710522f0.md): Essa é a sessão da documentação destinada ao esclarecimento de como funciona o processo de homologação dentro da nossa plataforma. - Documentos [Autenticação na API](https://api-doc.rakim.com.br/autentica%C3%A7%C3%A3o-na-api-6710474f0.md): - Documentos [Pagamentos](https://api-doc.rakim.com.br/pagamentos-6710464f0.md): - Documentos > Pagamentos [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710476f0.md): Nesta sessão vamos detalher a **API de Pagamentos** da plataforma. - Documentos > Pagamentos [Fingerprint](https://api-doc.rakim.com.br/fingerprint-7244031f0.md): - Documentos > Pagamentos [Criando um Pagamento](https://api-doc.rakim.com.br/criando-um-pagamento-6710477f0.md): Neste endpoint você pode solicitar a criação de um Pagamento **pré-autorizado** ou **autorização**. - Documentos > Pagamentos [Criando Pagamento com Split](https://api-doc.rakim.com.br/criando-pagamento-com-split-6710478f0.md): Criando um pagamento com Split de Liquidação - Documentos > Pagamentos [Capturando um Pagamento Pré-Autorizado](https://api-doc.rakim.com.br/capturando-um-pagamento-pr%C3%A9-autorizado-6710479f0.md): Captura de um valor pré-capturado - Documentos > Pagamentos [Cancelando um Pagamento](https://api-doc.rakim.com.br/cancelando-um-pagamento-6710480f0.md): Cancelando um Pagamento - Documentos > Pagamentos [Consultando informações do Pagamento](https://api-doc.rakim.com.br/consultando-informa%C3%A7%C3%B5es-do-pagamento-6710481f0.md): Neste endpoint você pode consultas informações sobre o pagamento e seu status. - Documentos > Pagamentos [Ativando um Split Tardio](https://api-doc.rakim.com.br/ativando-um-split-tardio-6710482f0.md): Neste endpoint você ativa os recebedores do _**Split Tardio**_, (também chamada de _Definição dos Recebedores_ ou _Participantes da Liquidação da transação_). Você pode obter mais informações, [clicando aqui](https://documenter.getpostman.com/view/40662984/2sAYJ6Bz2t#22600e87-7b71-48f5-9eae-561c8945ecb6). - Documentos > Pagamentos [Como Criar um Cofre de Cartão](https://api-doc.rakim.com.br/como-criar-um-cofre-de-cart%C3%A3o-6710483f0.md): Neste endpoint você pode criar um _**cofre de cartão**_ para armazenar os dados do cartão de forma criptografada. O cofre é associado a Loja específica que é autentidada na API pelo **Tokem da Loja** e pode receber outros cartões de compradores diferentes. - Documentos > Pagamentos [Inativar cofre de cartão](https://api-doc.rakim.com.br/inativar-cofre-de-cart%C3%A3o-6710484f0.md): Neste endpoint você pode inativar um cartão específico no cofre. - Documentos > Pagamentos [Listar os Cartões do Cofre](https://api-doc.rakim.com.br/listar-os-cart%C3%B5es-do-cofre-6710485f0.md): Neste endpoint você lista os tokens dos cartões no cofre para um determinado cliente. Consulte os cofres cadastrados por meio do documento enviado no endpoint de [Criação do Cofre de Cartão](https://documenter.getpostman.com/view/40662984/2sAYJ6Bz2t#ae31bcae-6098-444b-a519-f29700a47e02). - Documentos > Pagamentos [Consultando as Taxas da Transação](https://api-doc.rakim.com.br/consultando-as-taxas-da-transa%C3%A7%C3%A3o-6710486f0.md): Neste endpoint você pode consultar Taxas da Transação detalhada. - Documentos > Pagamentos [Listar Pagamentos](https://api-doc.rakim.com.br/listar-pagamentos-6710487f0.md): Utilize esse recurso para recuperar todos os pagamentos vinculados a uma Loja. Você tem a opção de filtrar os resultados selecionando o estado do pagamento desejado. - Documentos > Pagamentos [Cartões de Teste](https://api-doc.rakim.com.br/cart%C3%B5es-de-teste-6710488f0.md): Utilize os _**cartões**_ abaixo para testar todos os fluxos da API e mapeie os retornos esperados para cada operação. - Documentos > Pagamentos [Códigos de Retorno](https://api-doc.rakim.com.br/c%C3%B3digos-de-retorno-6710489f0.md): Os códigos de retorno da API são utilizadas pelas aplicações-clientes como forma de auxiliar na tomada de decisão da sua empresa. - Documentos > Pagamentos [Casos de Uso](https://api-doc.rakim.com.br/casos-de-uso-6710490f0.md): Veja a seguir alguns casos de uso da API de Pagamentos e seus diferentes fluxos de liquidação e processamento. - Documentos > PIX [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710491f0.md): Essa é a sessão da documentação destinada ao esclarecimento do escopo da API relacionado as cobranças bancárias por meio do Pix. - Documentos > PIX [Criar Cobrança Pix](https://api-doc.rakim.com.br/criar-cobran%C3%A7a-pix-6710492f0.md): Esse é o endpoint destinado a criação de cobranças Pix com o fornecimento de Copia e Cola e QrCode em formato base64. - Documentos > PIX [Consultar Cobrança Pix](https://api-doc.rakim.com.br/consultar-cobran%C3%A7a-pix-6710493f0.md): Consulte as cobranças Pix geradas como forma de obter o status da cobrança, taxas e informações relevantes. - Documentos > PIX [Devolução de Pagamento Pix](https://api-doc.rakim.com.br/devolu%C3%A7%C3%A3o-de-pagamento-pix-6710494f0.md): Solicite a devolução total das cobranças Pix criadas pagas. - Documentos > Link de Pagamento [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710495f0.md): Essa é a sessão de introdução ao escopo de **API de Link de Pagamento** oferecida pela nossa plataforma. Com ela você pode criar de modo intuitivo, link's, contendo checkout e cobrança de um pagamento via API para os métodos de pagamento aceito pela sua loja, sejam eles Pix ou Cartão de Crédito por meio do endpoint de [Criação do Link de Pagamento](https://documenter.getpostman.com/view/40662984/2sAYJ6Bz2t#e5fe7e68-aa48-412a-84ef-ddff9d52e461). - Documentos > Link de Pagamento [Criar Link de Pagamento](https://api-doc.rakim.com.br/criar-link-de-pagamento-6710496f0.md): Este endpoint é destinada a criação de link's de pagamento padrão da plataforma com checkout de pagamento para o cliente pagar através de Pix ou Cartão de Crédito. - Documentos > Link de Pagamento [Upload do Logo para Link de Pagamento](https://api-doc.rakim.com.br/upload-do-logo-para-link-de-pagamento-6710497f0.md): Este endpoint permite o upload de um logo personalizado para um Link de Pagamento específico, identificado pelo seu ID. A imagem enviada será armazenada e associada ao Link de Pagamento. Se for necessário alterar a imagem do logo do Link de Pagamento, é necessário fazer a requisição novamente. - Documentos > Recorrência [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710498f0.md): Essa é a sessão de introdução do escopo de API relacionado as recorrências presentes na plataforma. Com ela é possível que você crie cobranças de planos mensais (recorrentes) para usuários de sua plataforma por meio do endpoint de [Criação de Recorrência](https://documenter.getpostman.com/view/40662984/2sAYJ6Bz2t#f5bcfd0f-c1af-4a91-8209-60922e43cbde) ou pelo endpoint de [Criação de Link de Recorrência](https://documenter.getpostman.com/view/40662984/2sAYJ6Bz2t#52571b3c-fd30-41f2-bc25-d3a10cde2e4f). - Documentos > Recorrência [Criar Recorrência](https://api-doc.rakim.com.br/criar-recorr%C3%AAncia-6710499f0.md): ## Parâmetros do Objeto - Documentos > Recorrência [Criar Link de Recorrência](https://api-doc.rakim.com.br/criar-link-de-recorr%C3%AAncia-6710500f0.md): Esse é o endpoint destinado a criação de um link de recorrência contendo um checkout para ser pago por um participante da recorrência. - Documentos > Estabelecimentos [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710501f0.md): Essa é a sessão da documentação destinada ao esclarecimento do escopo de estabelecimentos na plataforma. - Documentos > Estabelecimentos [Criar Estabelecimento](https://api-doc.rakim.com.br/criar-estabelecimento-6710502f0.md): EndPoint destinado a criação de Lojas - Documentos > Estabelecimentos [Upload de documentos](https://api-doc.rakim.com.br/upload-de-documentos-6710503f0.md): EndPoint destinado ao upload de documentos para onboarding cliente. Cada documento deve ser enviado separadamente em uma requisição. - Documentos > Estabelecimentos [Buscar Estabelecimento](https://api-doc.rakim.com.br/buscar-estabelecimento-6710504f0.md): Esse é o endpoint destinado a busca de informações do estabelecimento através de seu `access_token`. - Documentos > Estabelecimentos [Listar CNAE's](https://api-doc.rakim.com.br/listar-cnaes-6710505f0.md): Esse é o endpoint destinado a listar todos os CNAE's que estão disponíveis em nossa plataforma. Com ele você consegue obter o ID do CNAE relacionado a Classificação Nacional de Atividades Econômicas da sua empresa para ser utilizada no momento de criação do estabelecimento. - Documentos > Estabelecimentos [Listar Bancos](https://api-doc.rakim.com.br/listar-bancos-6710506f0.md): Esse é o endpoint destinada a listagem de todos os bancos suportados pela nossa API para cadastro de estabelecimento na plataforma. - Documentos > Estabelecimentos [Casos de Uso](https://api-doc.rakim.com.br/casos-de-uso-6710507f0.md): Essa é a sessão da documentação destinada ao esclarecimento de casos de uso relacionados a API de Estabelecimentos. Nela, você encontrará exemplos de uso e observações sobre a utilização da API. - Documentos > Liquidações [Saque](https://api-doc.rakim.com.br/saque-6710508f0.md): Endpoint para solicitar saque do saldo livre no banco digital. - Documentos > Liquidações [Saldo](https://api-doc.rakim.com.br/saldo-6710509f0.md): Endpoint para consultar saldo live e bloqueado da conta digital - Documentos > Liquidações [Extrato](https://api-doc.rakim.com.br/extrato-6710510f0.md): Endpoint para consulta de liquidações realizadas para uma loja. - Documentos > Liquidações [Extrato Analítico](https://api-doc.rakim.com.br/extrato-anal%C3%ADtico-6710511f0.md): Endpoint para consulta analítica das liquidações realizadas para uma loja. - Documentos > Liquidações [Extrato Futuro](https://api-doc.rakim.com.br/extrato-futuro-6710512f0.md): Endpoint para consulta de liquidações Pendentes para uma loja. - Documentos > Antecipações [Introdução](https://api-doc.rakim.com.br/introdu%C3%A7%C3%A3o-6710513f0.md): Essa é a sessão de introdução a **API de Antecipação** oferecida pela nossa plataforma. Com ela você pode manter controle sobre as antecipações disponíveis pelo seu estabelecimento, gerenciar a antecipação automática ou não dos recebíveis e poder solicitar também a antecipação de um recebível futuro. - Documentos > Antecipações [Atualizar Antecipação Automática](https://api-doc.rakim.com.br/atualizar-antecipa%C3%A7%C3%A3o-autom%C3%A1tica-6710514f0.md): Esse é o endpoint destinado a atualização via API da antecipação automática ou não do estabelecimento. Se atente a qual tipo de operação você está atualizando a antecipação automática, visto que você pode desativa-lá ou ativa-lá tanto em operações onlines quanto operações físicas simultaneamente. - Documentos > Antecipações [Listar Antecipações Disponíveis](https://api-doc.rakim.com.br/listar-antecipa%C3%A7%C3%B5es-dispon%C3%ADveis-6710515f0.md): Esse é o endpoint destinada a consulta dos pagamentos aprovados que estão disponíveis a serem antecipados. - Documentos > Antecipações [Solicitar Antecipação](https://api-doc.rakim.com.br/solicitar-antecipa%C3%A7%C3%A3o-6710516f0.md): Esse é o endpoint destinada a consulta dos pagamentos aprovados que estão disponíveis a serem antecipados. - Documentos > Webhook's [Cadastrar Webhook](https://api-doc.rakim.com.br/cadastrar-webhook-6710517f0.md): Esse é o endpoint destinado ao cadastro de URL para ser notificado os pagamentos e as cobranças pix **de cada estabelecimento**. Dessa forma, é necessário que você cadastre e configure o webhook para cada estabelecimento. - Documentos > Webhook's [Reenvio de Webhook de Pagamento](https://api-doc.rakim.com.br/reenvio-de-webhook-de-pagamento-6710518f0.md): Esse é o endpoint destinado a solicitação de reenvio da webhook relacionado a um pagamento. - Documentos > Webhook's [Reenvio de Webhook de Estabelecimento](https://api-doc.rakim.com.br/reenvio-de-webhook-de-estabelecimento-6710519f0.md): Este é o endpoint destinado à solicitação de reenvio da webhook relacionada a um estabelecimento. - Documentos > Webhook's [Exemplo de Webhook](https://api-doc.rakim.com.br/exemplo-de-webhook-6710520f0.md): - Documentos > Status [Status de Pagamento](https://api-doc.rakim.com.br/status-de-pagamento-6710521f0.md): Os pagamentos podem ter diferentes status ao longo do processo. Os status abaixo são aplicáveis tanto para transações via **PIX** quanto **Cartão de Crédito**: ## API Docs - Documentos > Pagamentos > Criando um Pagamento [sales](https://api-doc.rakim.com.br/sales-28696297e0.md): # API Documentation - Documentos > Pagamentos > Criando Pagamento com Split [sales/splits](https://api-doc.rakim.com.br/salessplits-28696298e0.md): - Documentos > Pagamentos > Capturando um Pagamento Pré-Autorizado [capture](https://api-doc.rakim.com.br/capture-28696299e0.md): ## Schemas - Documentos > Pagamentos > Cancelando um Pagamento [cancel](https://api-doc.rakim.com.br/cancel-28696300e0.md): ## Schemas - Documentos > Pagamentos > Consultando informações do Pagamento [consulta](https://api-doc.rakim.com.br/consulta-28696301e0.md): ## Schemas - Documentos > Pagamentos > Ativando um Split Tardio [Split tardio](https://api-doc.rakim.com.br/split-tardio-28696302e0.md): ## Schemas - Documentos > Pagamentos > Como Criar um Cofre de Cartão [vault](https://api-doc.rakim.com.br/vault-28696303e0.md): ## Schemas - Documentos > Pagamentos > Inativar cofre de cartão [inativar vault](https://api-doc.rakim.com.br/inativar-vault-28696304e0.md): ## Schemas - Documentos > Pagamentos > Listar os Cartões do Cofre [Lista vault](https://api-doc.rakim.com.br/lista-vault-28696305e0.md): ## Schemas - Documentos > Pagamentos > Consultando as Taxas da Transação [Consultar taxas](https://api-doc.rakim.com.br/consultar-taxas-28696306e0.md): ## Schemas - Documentos > Pagamentos > Listar Pagamentos [Listar pagamentos](https://api-doc.rakim.com.br/listar-pagamentos-28696307e0.md): ## Schemas - Documentos > PIX > Criar Cobrança Pix [Cobranca pix](https://api-doc.rakim.com.br/cobranca-pix-28696308e0.md): ### ChargePix - Documentos > PIX > Consultar Cobrança Pix [Cobranca pix](https://api-doc.rakim.com.br/cobranca-pix-28696309e0.md): ### ChargePix - Documentos > PIX > Devolução de Pagamento Pix [Devolução pix](https://api-doc.rakim.com.br/devolu%C3%A7%C3%A3o-pix-28696310e0.md): ### Parameters - Documentos > Link de Pagamento > Criar Link de Pagamento [Criar Link de Pagamento](https://api-doc.rakim.com.br/criar-link-de-pagamento-28696311e0.md): - Documentos > Link de Pagamento > Upload do Logo para Link de Pagamento [Upload logo](https://api-doc.rakim.com.br/upload-logo-28696312e0.md): - Documentos > Recorrência > Criar Recorrência [Criar Recorrência](https://api-doc.rakim.com.br/criar-recorr%C3%AAncia-28696313e0.md): - Documentos > Recorrência > Criar Link de Recorrência [Criar link](https://api-doc.rakim.com.br/criar-link-28696314e0.md): - Documentos > Estabelecimentos > Criar Estabelecimento [Criar Estabelecimento](https://api-doc.rakim.com.br/criar-estabelecimento-28696315e0.md): - Documentos > Estabelecimentos > Upload de documentos [Upload de Documentos](https://api-doc.rakim.com.br/upload-de-documentos-28696316e0.md): - Documentos > Estabelecimentos > Buscar Estabelecimento [Busca estabelecimento](https://api-doc.rakim.com.br/busca-estabelecimento-28696317e0.md): - Documentos > Estabelecimentos > Listar CNAE's [Listar CNAE's](https://api-doc.rakim.com.br/listar-cnaes-28696318e0.md): - Documentos > Estabelecimentos > Listar Bancos [Listar Bancos](https://api-doc.rakim.com.br/listar-bancos-28696319e0.md): - Documentos > Liquidações > Saque [Solicitar Saque](https://api-doc.rakim.com.br/solicitar-saque-28696320e0.md): - Documentos > Liquidações > Saldo [Consultar Saldo](https://api-doc.rakim.com.br/consultar-saldo-28696321e0.md): - Documentos > Liquidações > Extrato [Busca extrato](https://api-doc.rakim.com.br/busca-extrato-28696322e0.md): - Documentos > Liquidações > Extrato Analítico [Busca extrato](https://api-doc.rakim.com.br/busca-extrato-28696323e0.md): - Documentos > Liquidações > Extrato Futuro [Busca extrato](https://api-doc.rakim.com.br/busca-extrato-28696324e0.md): - Documentos > Antecipações > Atualizar Antecipação Automática [Atualização Antecipação](https://api-doc.rakim.com.br/atualiza%C3%A7%C3%A3o-antecipa%C3%A7%C3%A3o-28696325e0.md): - Documentos > Antecipações > Listar Antecipações Disponíveis [Listar Antecipações](https://api-doc.rakim.com.br/listar-antecipa%C3%A7%C3%B5es-28696326e0.md): - Documentos > Antecipações > Solicitar Antecipação [Solicitar Antecipação](https://api-doc.rakim.com.br/solicitar-antecipa%C3%A7%C3%A3o-28696327e0.md): - Documentos > Webhook's > Cadastrar Webhook [Cadastrar Webhook](https://api-doc.rakim.com.br/cadastrar-webhook-28696328e0.md): - Documentos > Webhook's > Reenvio de Webhook de Pagamento [Reenvio de Webhook de Pagamento](https://api-doc.rakim.com.br/reenvio-de-webhook-de-pagamento-28696329e0.md): - Documentos > Webhook's > Reenvio de Webhook de Estabelecimento [Reenvio de Webhook de Estabelecimento](https://api-doc.rakim.com.br/reenvio-de-webhook-de-estabelecimento-28696330e0.md):