POST /v1/pix/keys/{accountId}

Este endpoint que permite a criação de chaves PIX para recebimento de pagamentos de forma rápida e fácil. Com este endpoint, nossos clientes podem cadastrar suas informações de pagamento, como CPF, telefone ou e-mail, e receber pagamentos por meio do PIX, que é uma forma de pagamento eletrônico criada pelo Banco Central do Brasil.

Body

  • pixKey string
  • account string
  • pixKeyType string

    Values are PHONE, EMAIL, RANDOM, CNPJ, or CPF.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer
    • data object
      Hide data attributes Show data attributes object
      • Success string
      • Message string
      • Key string | null
      • DocumentNumber integer
POST /v1/pix/keys/{accountId} 
curl \
 -X POST https://sandbox.agavos.com.br/v1/pix/keys/{accountId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"account":"asd8y123ba9sdg12ebashdhahashdab12312312","pixKeyType":"0","pixKey":"12322238999"}'
Request example 
{
  "account": "asd8y123ba9sdg12ebashdhahashdab12312312",
  "pixKeyType": "0",
  "pixKey": "12322238999"
}
Request examples 
{
  "pixKey": "12322238999",
  "account": "asd8y123ba9sdg12ebashdhahashdab12312312",
  "pixKeyType": "0"
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "Success": "true",
    "Message": "Solicitação para registro de chave do tipo Aleatória recebida com sucesso.",
    "Key": null,
    "DocumentNumber": 12312312312
  }
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "Key": null,
    "Message": "Solicitação para registro de chave do tipo Aleatória recebida com sucesso.",
    "Success": "true",
    "DocumentNumber": 1111
  }
}