Pagamento via PIX
Crie uma cobrança PIX pela API de Pagamentos da My Gateway e receba o código Copia e Cola para gerar o QR Code.
Nesta página
Para criar um PIX, envie paymentType: 2 e o objeto pix ao endpoint de criação. Não é necessário enviar os blocos de outros meios de pagamento como null.
Criar cobrança PIX#
/payments/v1/createCria a cobrança PIX e devolve o identificador do pagamento e o código Copia e Cola.
Cabeçalhos
AuthorizationstringobrigatórioValor de
authenticationTokenretornado na autenticação, sem o prefixoBearer.x-api-keystringobrigatórioChave do API Gateway do ambiente.
Content-TypestringobrigatórioSempre
application/json.
Corpo da requisição
paymentTypeintegerobrigatórioDeve ser
2para PIX.Valores aceitos:
2pixobjectobrigatórioDados da cobrança PIX.
Atributos de pix
clientChargeIdUUIDobrigatórioIdentificador da cobrança no sistema do integrador. Não o reutilize em cobranças diferentes.
fingerprintobjectobrigatórioFingerprint da sessão de checkout.
customerobjectobrigatórioDados do pagador.
valueintegerobrigatórioValor total em centavos. Maior que zero.
descriptionstringobrigatórioTexto que identifica a cobrança.
itemsarrayobrigatórioItens do pagamento. Precisa ter pelo menos um.
discountintegeropcionalDesconto total em centavos. Não pode ser negativo.
Padrão:
0expirationSecondsintegeropcionalValidade do QR Code em segundos. Quando informado, deve ser no mínimo
300. Se omitido, vale a configuração da conta.segmentstringopcionalCódigo de segmentação comercial previamente acordado com a My Gateway. Omita quando não fizer parte do seu contrato.
Corpo da requisição
{
"paymentType": 2,
"pix": {
"clientChargeId": "6fa85f64-5717-4562-b3fc-2c963f66afa9",
"fingerprint": {
"sessionId": "32c37c71-2b34-45e2-b678-d6627d0f9001",
"channel": 1,
"deviceInfo": {
"deviceId": "IDENTIFICADOR_DO_DISPOSITIVO",
"httpAcceptBrowserValue": "application/json",
"httpAcceptContent": "*/*",
"httpBrowserLanguage": "pt-BR",
"httpBrowserJavaEnabled": "N",
"httpBrowserJavaScriptEnabled": "Y",
"httpBrowserColorDepth": "24",
"httpBrowserScreenHeight": "1080",
"httpBrowserScreenWidth": "1920",
"httpBrowserTimeDifference": "180",
"userAgentBrowserValue": "Mozilla/5.0 (...)"
},
"network": {
"ip": "203.0.113.10",
"referer": "https://loja.exemplo.com/checkout",
"userAgent": "Mozilla/5.0 (...)"
}
},
"customer": {
"name": "Maria da Silva",
"document": "52998224725",
"email": "[email protected]",
"phoneNumber": "33334444",
"phoneNumberDDD": "11",
"mobilePhoneNumber": "999998888",
"mobilePhoneNumberDDD": "11",
"address": {
"street": "Rua Exemplo",
"number": "123",
"neighborhood": "Centro",
"zipcode": "01001000",
"city": "Sao Paulo",
"complement": "Apto 10",
"state": "SP",
"country": "BR"
}
},
"value": 1050,
"description": "Pedido 12345",
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Produto exemplo",
"value": 1050,
"amount": 1
}
],
"discount": 0,
"expirationSeconds": 900
}
}Requisição
# pix.json: o corpo da requisição mostrado acima
curl --request POST \
--url 'https://api.mygateway.com.br/payments/v1/create' \
--header 'Authorization: TOKEN_DE_AUTENTICACAO' \
--header 'x-api-key: SUA_API_KEY' \
--header 'Content-Type: application/json' \
--data @pix.json// payload: o corpo da requisição mostrado acima
const response = await fetch("https://api.mygateway.com.br/payments/v1/create", {
method: "POST",
headers: {
Authorization: token,
"x-api-key": process.env.MYGATEWAY_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const result = await response.json();<?php
// $payload: o corpo da requisição mostrado acima
$ch = curl_init('https://api.mygateway.com.br/payments/v1/create');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: ' . $token,
'x-api-key: ' . getenv('MYGATEWAY_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true);import os
import requests
# payload: o corpo da requisição mostrado acima
response = requests.post(
"https://api.mygateway.com.br/payments/v1/create",
headers={
"Authorization": token,
"x-api-key": os.environ["MYGATEWAY_API_KEY"],
},
json=payload,
)
result = response.json()Respostas
Cobrança criada.
JSON
{
"data": {
"paymentId": "8c8c9302-ff30-4dc4-bf57-345332d5e4ae",
"dueDate": "2026-10-29T18:45:00Z",
"qrCode": "00020126...6304ABCD"
}
}Payload inválido ou regra de negócio não atendida. Veja Erros.
ValidationError
{
"notificationErrors": {
"error": {
"erros": [
{
"propertyName": "items.value",
"propertyErrors": [
"O valor informado é inválido."
]
}
]
}
},
"errorTypeDescription": "ValidationError",
"errorType": 1
}Token ausente, inválido ou expirado.
JSON
{
"message": "Não autorizado",
"timestamp": "2026-10-29T21:30:00Z"
}Atributos da resposta
data.paymentIdUUIDobrigatórioIdentificador do pagamento na My Gateway. Guarde-o para consultar a situação.
data.dueDatedatetimeobrigatórioData e hora de expiração da cobrança.
data.qrCodestringobrigatórioPIX Copia e Cola. A imagem do QR Code pode ser gerada a partir deste texto.
Exibir o QR Code#
O atributo qrCode é o PIX Copia e Cola. Mostre esse texto para o pagador copiar e, se quiser, gere a imagem do QR Code a partir dele. A cobrança vale até dueDate.
Última atualização em
