Realizar pagamento PIX

post

https://api.homolog.redfoxpay.com.br/v1/gateway/create-pix-payment

Envia um pagamento PIX para uma chave Pix informada.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🔒 Liberação de IP em Produção

Para utilizar este endpoint, é necessário cadastrar previamente o IP do servidor de origem das requisições.

Por questões de segurança, apenas IPs autorizados poderão realizar operações de PIX de saída via API.

🧭 Como cadastrar o IP

Acesse o portal da RedFox Pay
Navegue até o menu:
Gateway → Gerenciamento de IPs
Adicione o IP do seu servidor e salve as alterações

⚠️ Importante

Requisições originadas de IPs não cadastrados serão automaticamente bloqueadas
Certifique-se de cadastrar todos os IPs utilizados pela sua aplicação (produção)

Body Params

amount

number

required

Valor do pagamento PIX. Deve ser maior que zero.

key

string

required

Chave Pix do destinatário. O formato deve ser compatível com o typeKey informado.

typeKey

string

enum

required

Tipo da chave Pix informada.

Allowed:

callbackUrl

uri

URL de callback para notificações de status da transação (opcional).

documentValidation

string

CPF ou CNPJ do titular esperado da chave Pix. Quando informado, a API valida se a chave pertence a esse documento antes de efetuar o pagamento (opcional).

externalId

string

Identificador externo único da transação (idempotência). Se informado, uma segunda requisição com o mesmo externalId retornará erro CLIENT_REFERENCE_ID_ALREADY_EXISTS (opcional).

description

string

length ≤ 140

Descrição livre da transação, exibida no comprovante. Máximo de 140 caracteres (opcional).

Responses

403

Erro de autenticação

🔒 Liberação de IP em Produção

🧭 Como cadastrar o IP

⚠️ Importante

200Pagamento PIX realizado com sucesso.

400Requisição inválida. Verifique os campos enviados.

404Chave Pix não encontrada ou inválida.

429Muitas tentativas inválidas. Conta temporariamente bloqueada para pagamento de Pix.