Cria uma subconta

POST/v1/subaccounts

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

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/subaccounts \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "daily_limit_centavos": 4990,
  "document": "12345678909",
  "email": "cliente@example.com",
  "external_reference": "pedido-12345",
  "monthly_limit_centavos": 4990,
  "name": "Cliente Exemplo"
}'

Resposta200 OK

{
  "data": {
    "daily_limit_centavos": "4990",
    "document": "12345678909",
    "email": "cliente@example.com",
    "external_reference": "pedido-12345",
    "id": "01HZ8K3M5N",
    "is_blocked": false,
    "monthly_limit_centavos": "4990",
    "name": "Cliente Exemplo",
    "public_id": "01HZ8K3M5N"
  },
  "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

daily_limit_centavosinteger

Limite diário, em centavos.

documentstringobrigatório

CPF ou CNPJ, só dígitos.

emailstring

E-mail.

external_referencestring

Referência do seu sistema (por exemplo, o ID do pedido).

monthly_limit_centavosinteger

Limite mensal, em centavos.

namestringobrigatório

Nome.

Precisa de ajuda? Fale com o suporte

curl -X POST https://integrate.api.kyvopay.com.br/v1/subaccounts \ -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \ -H "Content-Type: application/json" \ -d '{ "daily_limit_centavos": 4990, "document": "12345678909", "email": "cliente@example.com", "external_reference": "pedido-12345", "monthly_limit_centavos": 4990, "name": "Cliente Exemplo" }'

{ "data": { "daily_limit_centavos": "4990", "document": "12345678909", "email": "cliente@example.com", "external_reference": "pedido-12345", "id": "01HZ8K3M5N", "is_blocked": false, "monthly_limit_centavos": "4990", "name": "Cliente Exemplo", "public_id": "01HZ8K3M5N" }, "error": { "code": "string", "details": {}, "message": "string" }, "request_id": "req_01HZ8K3M5N" }