PluggyDocs
GET/payments/recipients/institutions/{id}

Retrieve Institution

Recovers the payment institution resource by its id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Retrieve a payment institution.
object

Response with information related to a payment institution

idrequiredstring

Primary identifier

namerequiredstring

Payment institution name

tradeNamerequiredstring

Payment institution trade name

ispbrequiredstring

Payment institution ISPB

compestring

Payment institution COMPE

createdAtrequiredstring (date-time)

Date when the payment institution was created

updatedAtrequiredstring (date-time)

Date when the payment institution was updated

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"
}

Code Examples

bash
curl -X GET 'https://api.pluggy.ai/payments/recipients/institutions/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Try It

Path Parameters