---
title: "Criar recebedor"
method: POST
path: "/recipients"
---

# Criar recebedor

`POST /recipients`

Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.

## Request body

- object
  - `name` string, required — Nome do recebedor. Max:128 caracteres
  - `email` string — E-mail do recebedor. Max: 64 caracteres
  - `description` string — Descrição do recebedor. Max:256 caracteres
  - `document` string, required — CPF ou CNPJ do recebedor. Max: 16 caracteres
  - `type` string, required — Tipo de recebedor. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica)
  - `code` string — Referencia externa única por recebedor
  - `default_bank_account` object, required — Dados da conta bancária do recebedor. [Saiba mais sobre conta bancaria de recebedores](https://docs.mundipagg.com/v1/reference#conta-bancária)
  - `transfer_settings` object — Informações de transferência do recebedor
  - `automatic_anticipation_settings` object — Informações de antecipação automática do recebedor
  - `holder_name` string — Nome da conta. Max: 30 caracteres
  - `bank` string — Número da conta. Max 3 caracteres numéricos
  - `branch_number` string — Número da agência. Max 4 caracteres
  - `branch_check_digit` string — Digito validador da agência. Max: 1 caracter numérico
  - `account_number` string — Número da conta. Max: 13 caracteres numéricos
  - `account_check_digit` string — Digitos validadores da conta. Max 2 caracteres numéricos
  - `metadata` object — Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata)

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `email` string
  - `document` string
  - `description` string
  - `type` string
  - `status` string
  - `created_at` string
  - `updated_at` string
  - `transfer_settings` object
    - `transfer_enabled` boolean
    - `transfer_interval` string
    - `transfer_day` integer
  - `default_bank_account` object
    - `id` string
    - `holder_name` string
    - `holder_type` string
    - `holder_document` string
    - `bank` string
    - `branch_number` string
    - `branch_check_digit` string
    - `account_number` string
    - `account_check_digit` string
    - `type` string
    - `status` string
    - `created_at` string
    - `updated_at` string
    - `metadata` object
      - `key` string
  - `gateway_recipients` object[]
    - `gateway` string
    - `status` string
    - `pgid` string
    - `createdAt` string
    - `updatedAt` string
  - `automatic_anticipation_settings` object
    - `enabled` boolean
    - `type` string
    - `volume_percentage` integer
    - `delay` integer
  - `metadata` object
    - `key` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/mundipagg/apis/mundipagg-api.md) · [All operations](https://skmtc.net/mundipagg/apis/mundipagg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mundipagg/mundipagg-api/versions/1ddb9f03a82d/schema)