v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Atualizar informações de antecipação automática

patch/recipients/{recipient_Id}/automatic-anticipation-settings

Path parameters

recipient_idstring required

Identificador do recebedor

Request body

enabledboolean

Variável que indica se o recebedor irá possuir antecipação automaticamentica.

typestring

Configuração de como devemos criar as antecipações automáticas do recebedor. Valores possíveis full e 1025. Se informado full será criada antecipações seguindo a regra de volume máximo antecipável. Se informado 1025 será criada antecipações de vendas inteiras, modelos D+X e 10/25.

volume_percentagestring

Porcentagem do valor passível de antecipação para este recebedor. Valores entre 0 e 100.

daysstring[]

Lista de dias em que serão criar as antecipações automáticas. Valores possíveis de 1 a 31, necessário informar entre chaves"[ ]"

delaystring

Quantidade de dias, contados a partir do dia da antecipação para trás, que serão desconsiderados na criação desta antecipação

Response

200

idstring

namestring

emailstring

documentstring

descriptionstring

typestring

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "rp_23452cBK6lP",
  "name": "Tony Stark",
  "email": "tstark@avengers.com",
  "document": "223451990",
  "description": "Recebedor Tony Stark",
  "type": "individual",
  "status": "active",
  "created_at": "2018-05-23T16:17:39Z",
  "updated_at": "2018-05-23T16:17:39Z",
  "transfer_settings": {
    "transfer_interval": "Daily"
  },
  "default_bank_account": {
    "id": "ba_2LYnR234Og",
    "holder_name": "Tony Stark",
    "holder_type": "individual",
    "holder_document": "26224451990",
    "bank": "341",
    "branch_number": "12345",
    "branch_check_digit": "6",
    "account_number": "12345",
    "account_check_digit": "6",
    "type": "checking",
    "status": "active",
    "created_at": "2018-05-23T16:17:40Z",
    "updated_at": "2018-05-23T16:17:40Z",
    "metadata": {
      "key": "value"
    }
  },
  "automatic_anticipation_settings": {
    "enabled": true,
    "type": "full",
    "volume_percentage": 50,
    "delay": 365,
    "days": [
      1
    ]
  },
  "gateway_recipients": [
    {
      "gateway": "pagarme",
      "status": "active",
      "pgid": "re_cjhjb34244o9jw6dyx5aizxn",
      "createdAt": "2018-05-23T16:17:45Z",
      "updatedAt": "2018-05-23T16:17:45Z"
    }
  ],
  "metadata": {
    "key": "value"
  }
}