PApagar

Listar recebedores

Changed on

Retorna uma lista de objetos com os dados dos recebedor encontrados.

get/recipients

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/recipients
  • Auth
    HTTP basic

Query parameters

pageinteger

Página atual.

sizeinteger

Quantidade de itens por página.

Response

200

Example response

{
  "data": [
    {
      "id": "rp_Gxb5NJNiqvf0Y5Xv",
      "name": "Tony Stark",
      "email": "tstark@avengers.com",
      "document": "26224451990",
      "description": "Recebedor Tony Stark",
      "type": "individual",
      "status": "active",
      "created_at": "2017-10-27T16:12:37Z",
      "updated_at": "2017-10-27T16:12:37Z",
      "transfer_settings": {
        "transfer_interval": "Daily"
      },
      "default_bank_account": {
        "id": "ba_KOoYDmEHvIEYD6v3",
        "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-10-27T19:03:21Z",
        "updated_at": "2017-10-27T19:03:21Z",
        "metadata": {
          "meta_key": "meta_value"
        }
      },
      "metadata": {
        "key": "value"
      }
    }
  ],
  "paging": {
    "total": 1
  }
}

Changes