v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Obter recebedor

Retorna um objeto com os dados de um recebedor específico.

get/recipients/{recipient_id}

Path parameters

recipient_idstring required

Código do recebedor.

Query parameters

codestring

Referencia externa única por recebedor

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": "12345",
    "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"
    }
  ],
  "metadata": {
    "key": "value"
  }
}