Documentação para desenvolvedores
Integre pagamentos ao seu sistema
Referência das APIs da My Gateway para PIX, cartão com 3DS e link de pagamento, com exemplos prontos para copiar em cURL, Node.js, PHP e Python.
/authentication/v1/authcURL
curl --request POST \
--url 'https://api.mygateway.com.br/authentication/v1/auth' \
--header 'Content-Type: application/json' \
--header 'x-api-key: SUA_API_KEY' \
--data '{"authData":"BASE64_DE_CLIENT_ID:CLIENT_SECRET"}'200 OK
Token válido até expiresIn
{
"authenticationToken": "TOKEN_DE_AUTORIZACAO",
"expiresIn": "2026-10-29T18:30:00-03:00"
}Por onde quer começar?
Cada API tem guias de integração, a referência completa dos atributos e exemplos de requisição e resposta.
Autenticação
Gere o token de acesso usado em todas as APIs da My Gateway e veja as práticas de segurança da integração.
2 guias
Abrir AutenticaçãoAPI de Pagamentos
Crie cobranças PIX e pagamentos com cartão e 3DS e acompanhe a situação de cada pagamento.
- POST
/payments/v1/create - POST
/payments/v1/creditcard/generate/token - GET
/payments/v1/situation/by/{paymentId}
7 guias
Abrir API de Pagamentos- POST
Antifraude e 3DS
Fingerprint do comprador e autenticação 3DS do portador do cartão: SDK, desafio e validação.
4 guias
Abrir Antifraude e 3DSLink de Pagamento
Crie e consulte links de pagamento (checkout) e acompanhe as cobranças geradas por cada link.
- POST
/payments/v1/checkout - GET
/payments/v1/checkout/{payment-link-id} - GET
/payments/v1/checkout/charges/{payment-link-id}
5 guias
Abrir Link de Pagamento- POST
- Abrir Referência
Referência
Lista dos códigos de erro MYG retornados pelas APIs da My Gateway, com a mensagem e a explicação de cada um.
Do token ao primeiro pagamento
Três chamadas levam você da credencial a um PIX confirmado.
Gere o token
Troque o clientId e o clientSecret por um token de acesso. Reutilize-o até ele expirar.
POSTVer autenticação/authentication/v1/authCrie a cobrança
Envie o pagador, os itens e o valor em centavos e receba o código PIX Copia e Cola.
POSTVer pagamento via PIX/payments/v1/createConfirme o pagamento
Consulte o paymentId até a situação chegar a Paid. Só então libere o pedido.
GETVer consulta de pagamento/payments/v1/situation/by/{paymentId}
Exemplos na sua linguagem
Escolha uma linguagem e os blocos de código de toda a documentação passam a abrir nela. A escolha fica salva neste navegador.
Os exemplos da documentação vão abrir em cURL.
Consultar um pagamento
curl --request GET \
--url 'https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7' \
--header 'Authorization: TOKEN_DE_AUTENTICACAO' \
--header 'x-api-key: SUA_API_KEY'const response = await fetch("https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7", {
headers: {
Authorization: token,
"x-api-key": process.env.MYGATEWAY_API_KEY,
},
});
const { situation } = await response.json();<?php
$ch = curl_init('https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7');
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => [
'Authorization: ' . $token,
'x-api-key: ' . getenv('MYGATEWAY_API_KEY'),
],
CURLOPT_RETURNTRANSFER => true,
]);
$situation = json_decode(curl_exec($ch), true)['situation'];import os
import requests
response = requests.get(
"https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7",
headers={
"Authorization": token,
"x-api-key": os.environ["MYGATEWAY_API_KEY"],
},
)
situation = response.json()["situation"]Precisa de ajuda com a integração?
Fale com o nosso time de suporte e revise as regras de segurança antes de levar a integração para produção.
