Introdução

Princípios básicos

Bem-vindo ao Guia de referência da API Marlim Pix! Nossa API é RESTful e é através dela que você integra seu sistema ao nosso.

Todas as chamadas para nossa API usam verbos REST comuns e todas as respostas são retornadas no formato JSON.

info

Nossa API não aceita null, undefined ou empty valores de string em qualquer endpoint. Se passar um parâmetro com qualquer um destes 3 valores, será retornado um erro. Caso o parâmetro não seja obrigatório e você não queira que ele seja computado, basta removê-lo da requisição.

Ambientes

Para fazer transações com Marlim você tem acesso a duas chaves de API diferentes e dois ambientes diferentes: Sandbox e Produção. Desta forma, é possível diferenciar o ambiente escolhendo a api_key e o endpoint base apropriados para o tipo de operação que você deseja realizar, seguindo as orientações abaixo:

Sandbox

https://sandbox.api.pix.marlim.co

Produção

https://api.pix.marlim.co

danger

As chaves de autenticação para o ambiente de produção têm o poder de realizar qualquer operação em nossa API, por isso é extremamente importante que você as guarde em um local seguro, e que não as exponha no cliente-side do seu aplicativo.

Autenticação

Sempre que sua aplicação chamar um de nossos endpoints, você deverá passar sua API Key adicionada ao Header da requisição como forma de autenticação, utilizando o seguinte formato:

"api_key": "seu_api_key_value"

note

Sua api_key deve ser solicitada à nossa equipe de Suporte ou Desenvolvimento.

Códigos de resposta

Nossa API usa códigos HTTP padrão como retorno para indicar o sucesso de uma solicitação e para indicar falha.

Code	Meaning
200	Tudo correu como deveria e sua solicitação foi processada com sucesso.
400	Algum parâmetro obrigatório não foi passado ou os parâmetros passados não estão corretos.
401	Falta de autorização para acessar este endpoint.
403	O valor passado no parâmetro está incorreto.
404	Endpoint ou algum valor não encontrado.
405	Método não autorizado.
408	Tempo limite de 60 segundos atingido.
500	Erro interno do Marlim, tente novamente. Se continuar, entre em contato conosco.

Versão

A versão mais atual da API é: v1