Ambientes e base URL

Base URL, versionamento por /v1, formato JSON e cabeçalhos aceitos.

Base URL

Todas as rotas ficam em https://api.maxxipay.com e devem ser chamadas por HTTPS.

Base URLURL

https://api.maxxipay.com

Versionamento

A versão vai no caminho: /v1. Dentro da mesma versão a MaxxiPay só faz mudanças compatíveis, como novos campos na resposta, novos eventos e novos parâmetros opcionais.

Ignore campos que você não conhece e trate tipos de evento novos sem quebrar. Mudanças incompatíveis saem numa nova versão e são anunciadas no changelog.

Formato das requisições

Cabeçalho	Quando	Valor
`Authorization`	Sempre	Bearer com a chave de API
`Content-Type`	Requisições com corpo	application/json
`Idempotency-Key`	POST /v1/charges e POST /v1/payouts	8 a 120 caracteres
`X-Request-Id`	Opcional	8 a 64 caracteres entre letras, números, ponto, hífen e sublinhado

O corpo vai em JSON UTF-8 com até 1 MB. Os campos usam camelCase e as datas seguem ISO 8601 em UTC.

Request ID

Toda resposta traz X-Request-Id, e todo erro repete o valor em error.requestId. Guarde esse identificador nos seus logs e informe ao suporte quando precisar de ajuda.

Se você mandar o seu próprio X-Request-Id num formato aceito, a MaxxiPay usa o mesmo valor, o que facilita cruzar logs.

Cabeçalhos da respostaHTTP

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
X-Request-Id: req_Q2x8mZp4LkT7aV1c
RateLimit-Limit: 300
RateLimit-Remaining: 299
RateLimit-Reset: 41

Como testar

Hoje existe um único ambiente, o de produção, com chaves mxp_live_. Para validar a integração, crie cobranças de valor baixo e pague com uma conta da própria empresa.