Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
GET/payments/recipients/institutions/{id}

Recuperar Instituição

Recupera o recurso da instituição de pagamento pelo seu id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Recuperar uma instituição de pagamento.
object

Resposta com informações relacionadas a uma instituição de pagamento

idrequiredstring

Identificador principal

namerequiredstring

Nome da instituição de pagamento

tradeNamerequiredstring

Nome comercial da instituição de pagamento

ispbrequiredstring

Instituição de pagamento ISPB

compestring

Instituição de pagamento COMPE

createdAtrequiredstring (date-time)

Data em que a instituição de pagamento foi criada

updatedAtrequiredstring (date-time)

Data em que a instituição de pagamento foi atualizada

Example response

json
{
  "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "name": "Banco J. Safra S.A.",
  "ispb": "03017677",
  "tradeName": "Banco Safra",
  "compe": "074",
  "createdAt": "2020-04-21T15:00:00.000Z",
  "updatedAt": "2020-04-21T15:00:00.000Z"
}
curl -X GET \
'https://api.pluggy.ai/payments/recipients/institutions/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
"id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
"name": "Banco J. Safra S.A.",
"ispb": "03017677",
"tradeName": "Banco Safra",
"compe": "074",
"createdAt": "2020-04-21T15:00:00.000Z",
"updatedAt": "2020-04-21T15:00:00.000Z"
}