Referência da API/Saques
POST
Sincroniza o status de um saque com o provedor
Sincroniza o status de um saque com o provedor
POST
/v1/payouts/{payoutId}/synchttps://integrate.api.kyvopay.com.br
cURL
curl -X POST https://integrate.api.kyvopay.com.br/v1/payouts/{payoutId}/sync \
-H "X-API-Key: ky_XXXXX-XXXXX-XXXXX"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órioUse a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.
Requisição
Parâmetros
payoutIdstringobrigatórioIdentificador do saque.