Anexa uma regra de split (divisão) a um pagamento ainda não pago

POST/v1/payments/{paymentId}/split

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

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/payments/{paymentId}/split \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "percent",
  "recipients": "string"
}'

Resposta200 OK

{
  "data": {
    "id": "01HZ8K3M5N",
    "mode": "string",
    "payment_id": "01HZ8K3M5N",
    "recipients": "string"
  },
  "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

Parâmetros

paymentIdstringobrigatório

Identificador do pagamento.

Corpo

modestringobrigatório

Modo da divisão: percent ou fixed. Não se misturam na mesma regra.

recipientsarray,nullobrigatório

Recebedores da divisão.

Precisa de ajuda? Fale com o suporte