API de Pagamentos
Visão geral da API pública de Pagamentos da My Gateway: endpoints, headers, formatos de dados e convenções do contrato.
Nesta página
A API de Pagamentos cria cobranças PIX e pagamentos com cartão de crédito com autenticação 3DS, e permite consultar a situação de cada pagamento.
Ambiente#
| Item | Valor |
|---|---|
| Base URL de produção | https://api.mygateway.com.br |
| Formato de dados | JSON (application/json) |
| Autenticação | Token no header Authorization (como obter) |
| Chave do API Gateway | Header x-api-key |
Endpoints#
| Finalidade | Método | Endpoint |
|---|---|---|
| Autenticar a integração | POST | /authentication/v1/auth |
| Inicializar o SDK 3DS | POST | /antifraud/v1/sdk/3ds/initialize |
| Tokenizar um cartão | POST | /payments/v1/creditcard/generate/token |
| Criar um PIX | POST | /payments/v1/create |
| Criar um pagamento no cartão | POST | /payments/v1/create |
| Validar um desafio 3DS | POST | /payments/v1/creditcard/antifraud/validate/3ds |
| Consultar um pagamento | GET | /payments/v1/situation/by/{paymentId} |
Headers#
POST /authentication/v1/auth
Content-Type: application/json
x-api-key: SUA_API_KEYTodas as outras chamadas
Content-Type: application/json
x-api-key: SUA_API_KEY
Authorization: TOKEN_RETORNADO_NA_AUTENTICACAOO valor de Authorization é o authenticationToken retornado na autenticação, enviado exatamente como recebido, sem Bearer. A x-api-key não substitui esse token.
Tipos e formatos#
| Tipo | Regra |
|---|---|
| Dinheiro | Inteiro em centavos. Ex.: 1050 representa R$ 10,50. Não envie decimal. |
| UUID | Texto no formato xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, diferente do UUID vazio. |
| Documento | CPF ou CNPJ válido, somente dígitos. |
| Telefone | DDD e número em atributos separados, de preferência só com dígitos. |
| Data e hora | ISO 8601, salvo quando o campo indicar explicitamente Unix timestamp. |
| Campos nulos | A API pode omitir atributos nulos nas respostas. Não dependa da presença de campos condicionais. |
| Nomes JSON | Sensíveis à grafia do contrato. Use exatamente theeDs e code3DS. |
Fluxos#
- PIX: crie a cobrança, mostre o código Copia e Cola e consulte a situação.
- Cartão com 3DS: inicialize o SDK 3DS, tokenize o cartão, crie o pagamento e trate o desafio quando houver.
- Consulta: acompanhe a situação até um estado final. Só confirme o pedido em
Paid.
Última atualização em
