v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Criar recebedor

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.

post/recipients

Request body

namestring required

Nome do recebedor. Max:128 caracteres

emailstring

E-mail do recebedor. Max: 64 caracteres

descriptionstring

Descrição do recebedor. Max:256 caracteres

documentstring required

CPF ou CNPJ do recebedor. Max: 16 caracteres

typestring required

Tipo de recebedor. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica)

codestring

Referencia externa única por recebedor

default_bank_accountobject required

Dados da conta bancária do recebedor. Saiba mais sobre conta bancaria de recebedores

transfer_settingsobject

Informações de transferência do recebedor

automatic_anticipation_settingsobject

Informações de antecipação automática do recebedor

holder_namestring

Nome da conta. Max: 30 caracteres

bankstring

Número da conta. Max 3 caracteres numéricos

branch_numberstring

Número da agência. Max 4 caracteres

branch_check_digitstring

Digito validador da agência. Max: 1 caracter numérico

account_numberstring

Número da conta. Max: 13 caracteres numéricos

account_check_digitstring

Digitos validadores da conta. Max 2 caracteres numéricos

metadataobject

Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor. Saiba mais sobre metadata

Response

200

idstring

namestring

emailstring

documentstring

descriptionstring

typestring

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "rp_P6b2aBqtPsbwG7xw",
  "name": "Tony Stark",
  "email": "tstark@mundipagg.com",
  "document": "26224451990",
  "description": "Recebedor tony stark",
  "type": "individual",
  "status": "active",
  "created_at": "2017-08-03T20:29:28Z",
  "updated_at": "2017-08-03T20:29:28Z",
  "transfer_settings": {
    "transfer_interval": "Daily"
  },
  "default_bank_account": {
    "id": "ba_Ez2lE71FBUPa3XZK",
    "holder_name": "Tony Stark",
    "holder_type": "individual",
    "holder_document": "26224451990",
    "bank": "341",
    "branch_number": "1234",
    "branch_check_digit": "6",
    "account_number": "12345",
    "account_check_digit": "6",
    "type": "checking",
    "status": "active",
    "created_at": "2017-08-03T20:29:28Z",
    "updated_at": "2017-08-03T20:29:28Z",
    "metadata": {
      "key": "value"
    }
  },
  "gateway_recipients": [
    {
      "gateway": "pagarme",
      "status": "active",
      "pgid": "re_cj5aaa5i000cdhj6ernz14j1i",
      "createdAt": "2017-08-03T20:29:28Z",
      "updatedAt": "2017-08-03T20:29:28Z"
    }
  ],
  "automatic_anticipation_settings": {
    "enabled": true,
    "type": "full",
    "volume_percentage": 50,
    "delay": 365
  },
  "metadata": {
    "key": "value"
  }
}