Solicita um envio Pix (saque)

POST/v1/payouts

https://integrate.api.kyvopay.com.br

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/payouts \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_centavos": 4990,
  "idempotency_key": "pedido-12345",
  "pix_key": "cliente@example.com",
  "pix_key_type": "email"
}'

Resposta200 OK

{
  "data": {
    "amount_centavos": "4990",
    "end_to_end_id": "E12345678202601011200abcdef123456",
    "failure_reason": "string",
    "fee_centavos": "4990",
    "id": "01HZ8K3M5N",
    "net_centavos": "4990",
    "pix_key": "cliente@example.com",
    "pix_key_type": "email",
    "public_id": "01HZ8K3M5N",
    "status": "pending"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Corpo

amount_centavosintegerobrigatório

Valor em centavos. R$ 49,90 = 4990.

idempotency_keystring

Chave de idempotência. Repetir a chamada com a mesma chave devolve o resultado original em vez de criar de novo.

pix_keystringobrigatório

Chave Pix de destino.

pix_key_typestringobrigatório

Tipo da chave Pix: cpf, cnpj, email, phone ou evp (chave aleatória).

Precisa de ajuda? Fale com o suporte

curl -X POST https://integrate.api.kyvopay.com.br/v1/payouts \ -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \ -H "Content-Type: application/json" \ -d '{ "amount_centavos": 4990, "idempotency_key": "pedido-12345", "pix_key": "cliente@example.com", "pix_key_type": "email" }'

{ "data": { "amount_centavos": "4990", "end_to_end_id": "E12345678202601011200abcdef123456", "failure_reason": "string", "fee_centavos": "4990", "id": "01HZ8K3M5N", "net_centavos": "4990", "pix_key": "cliente@example.com", "pix_key_type": "email", "public_id": "01HZ8K3M5N", "status": "pending" }, "error": { "code": "string", "details": {}, "message": "string" }, "request_id": "req_01HZ8K3M5N" }