v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Atualizar configurações de transferência

patch/recipients/{recipient_id}/transfer-settings

Path parameters

recipient_idstring required

Identificador do recebedor

Request body

transfer_enabledboolean required

Variável que indica se o recebedor irá receber os transferências automaticamente.

transfer_intervalstring required

Frequência na qual o recebedor irá receber transferências. Valores possíveis: daily, weekly, monthly

transfer_dayinteger required

Dia no qual o recebedor vai receber a transferência. Depende do transfer_interval. Se for daily, é necessário informar 0. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31.

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"
    }
  },
  "gateway_recipients": [
    {
      "gateway": "pagarme",
      "status": "active",
      "pgid": "re_cjhjb34244o9jw6dyx5aizxn",
      "createdAt": "2018-05-23T16:17:45Z",
      "updatedAt": "2018-05-23T16:17:45Z"
    }
  ],
  "metadata": {
    "key": "value"
  }
}