# Criar chave PIX (metodo de pagamento)

`POST /instance/account/pay/pix-key`

Pasta: **Instancia**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Criar chave PIX (método de pagamento)

Atalho para registrar uma chave PIX como método de pagamento custom (`type=pix_key`, `flow=p2m`). Mobile only.

## Endpoint

``` http
POST {{baseUrl}}/instance/account/pay/pix-key
```

## Autenticação

``` http
token: {{token}}
```

## Corpo

``` json
{
  "country": "BR",
  "key_type": "CPF",
  "display_name": "Loja Exemplo",
  "pix_key": "00000000000"
}
```

## Resposta

``` json
{
  "success": true,
  "method": {
    "credential_id": "…",
    "country": "BR",
    "type": "pix_key",
    "flow": "p2m",
    "metadata": {
      "pix_key_type": "CPF",
      "pix_display_name": "Loja Exemplo",
      "pix_key": "00000000000"
    }
  }
}
```

## Observações

`key_type` aliases: `pix_key_type`. `pix_key` aliases: `key`. `display_name` aliases: `pix_name`. `country` padrão: `BR`.

## Corpo (exemplo)

```json
{
  "country": "BR",
  "key_type": "CPF",
  "display_name": "Loja Exemplo",
  "pix_key": "00000000000"
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/instance/account/pay/pix-key" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "country": "BR",
  "key_type": "CPF",
  "display_name": "Loja Exemplo",
  "pix_key": "00000000000"
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=instancia/criar-chave-pix-metodo-de-pagamento)