Enviar valor para chave

Executa o envio de valor para uma chave PIX. Recomenda-se consultar a chave antes (POST /pix/query) para confirmar o destinatário.

Overview

Endpoint de cash-out: debita o saldo da conta e envia para a chave informada.

Requisitos

Saldo disponível e API Key com permissão para envio PIX. Valor em centavos.

Endpoint

POSTPOST /pix/payment

Base URL:https://api.onnixpay.com/api/v1/sdk

Headers

Header	Obrigatório	Descrição
X-API-Key	Sim	Sua API Key.
Content-Type	Sim	Obrigatório.

Body Parameters

Todas as propriedades do corpo da requisição, com tipo, obrigatoriedade, restrições e exemplo.

Campo	Tipo	Obrigatório	Descrição	Enum	Exemplo
pixKey	string	Sim	Chave PIX do destinatário. Pode ser o keyValue retornado por POST /pix/query.	—	pagador@email.com
amount	number	Sim	Valor em centavos a enviar. Ex.: 10000 = R$ 100,00. Deve haver saldo disponível.Inteiro positivo. Saldo suficiente na conta.	—	10000
endToEndId	string	Não	ID end-to-end para rastreio do pagamento (definir formato).	—	E12345678202502091200abcdef
description	string	Não	Descrição ou motivo do pagamento exibida ao destinatário.	—	Reembolso pedido #X
feeDeduction	string	Não	Se e como a taxa é considerada no valor (definir).	FROM_AMOUNT \| ADD_TO_AMOUNT	FROM_AMOUNT

Exemplo cURL

cURL

curl -X POST "https://api.onnixpay.com/api/v1/sdk/pix/payment" \
  -H "X-API-Key: ox_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
  "pixKey": "pagador@email.com",
  "amount": 10000,
  "description": "Reembolso"
}'

Response — Sucesso (201)

JSON

{
  "id": "pay_abc123",
  "status": "processing",
  "amount": 10000,
  "pixKey": "pagador@email.com",
  "createdAt": "2025-02-09T12:00:00.000Z"
}

Campos da resposta

Campo	Tipo	Descrição
id	string	Identificador do pagamento.
status	string	processing \| completed \| failed.
amount	number	Valor em centavos.
pixKey	string	Chave para a qual foi enviado.
createdAt	string	Data/hora de criação (ISO 8601).

Status codes e erros comuns

Status	Código	Mensagem
400	INVALID_REQUEST	Payload inválido ou saldo insuficiente.
401	INVALID_API_KEY	Chave de API inválida ou ausente.
429	RATE_LIMIT_EXCEEDED	Limite de requisições excedido.

Exemplo de resposta de erro

JSON

{
  "code": "INVALID_REQUEST",
  "message": "Saldo insuficiente para a operação."
}

Headers

X-API-Key: ox_sua_chave_aqui
Content-Type: application/json

Request body (JSON)

{
  "pixKey": "pagador@email.com",
  "amount": 10000,
  "description": "Reembolso"
}

cURL

curl -X POST "https://api.onnixpay.com/api/v1/sdk/pix/payment" \
  -H "X-API-Key: ox_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
  "pixKey": "pagador@email.com",
  "amount": 10000,
  "description": "Reembolso"
}'

Response (201)

{
  "id": "pay_abc123",
  "status": "processing",
  "amount": 10000,
  "pixKey": "pagador@email.com",
  "createdAt": "2025-02-09T12:00:00.000Z"
}