GET/payments/recipients/{id}

Recuperar

Recupera o recurso do destinatário do pagamento pelo seu id

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador principal do destinatário do pagamento

Responses

200Recuperar um destinatário.

object

Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.

typerequiredstring

Discriminador do destinatário. Sempre `BANK_ACCOUNT` para este esquema.

BANK_ACCOUNT

idrequiredstring

Identificador principal

taxNumberrequiredstring

Número de identificação fiscal do titular da conta. Pode ser CPF ou CNPJ (apenas números).

namerequiredstring

Nome do proprietário da conta.

paymentInstitutionrequiredobject

Instituição que possui a conta bancária do destinatário.

All of:

part 1object

Response with information related to a payment institution

isDefaultrequiredboolean

Indica se o destinatário é o padrão

accountrequiredobject

Payment receiver bank account information

branchrequiredstring

Agência da conta bancária do recebedor

numberrequiredstring

Número da conta bancária do recebedor

typerequiredstring

Tipo de conta bancária do recebedor, pode ser: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' ou 'GUARANTEED_ACCOUNT'

pixKeystring | null

Chave Pix associada ao destinatário do pagamento

createdAtrequiredstring (date-time)

Data em que o destinatário do pagamento foi criado

updatedAtrequiredstring (date-time)

Data em que o destinatário do pagamento foi atualizado pela última vez

Example response

json

{
  "type": "BANK_ACCOUNT",
  "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "name": "Conta empresa",
  "taxNumber": "12345678900",
  "paymentInstitution": {
    "id": "00000000-0000-0000-0000-000000000000",
    "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"
  },
  "account": {
    "branch": "0001",
    "number": "123456",
    "type": "CHECKING_ACCOUNT"
  },
  "isDefault": false,
  "pixKey": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

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

Resposta de exemplo

{
  "type": "BANK_ACCOUNT",
  "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "name": "Conta empresa",
  "taxNumber": "12345678900",
  "paymentInstitution": {
    "id": "00000000-0000-0000-0000-000000000000",
    "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"
  },
  "account": {
    "branch": "0001",
    "number": "123456",
    "type": "CHECKING_ACCOUNT"
  },
  "isDefault": false,
  "pixKey": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}