v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Payment Recipient

Retrieve Institution

Recovers the payment institution resource by its id

get/payments/recipients/institutions/{id}

Path parameters

idstring uuid required

Payment institution primary identifier

Response

Retrieve a payment institution.

idstring required

Primary identifier

namestring required

Payment institution name

tradeNamestring required

Payment institution trade name

ispbstring required

Payment institution ISPB

compestring

Payment institution COMPE

createdAtstring date-time required

Date when the payment institution was created

updatedAtstring date-time required

Date when the payment institution was updated

Example response

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