v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Adicionar beneficiários

Este endpoint é usado para adicionar beneficiários à conta Grafeno.

post/beneficiaries

Request body

namestring

Nome completo ou razão social do beneficiário.

documentNumberstring

Número do documento do beneficiário, podendo ser CPF (para pessoas físicas) ou CNPJ (para pessoas jurídicas).

bankCodestring

Código do banco onde a conta beneficiária está registrada.

agencystring

Número da agência bancária do beneficiário.

accountstring

Número da conta bancária do beneficiário, incluindo o dígito verificador.

Response

200

Example response

{
  "data": {
    "id": "48347e3f-ff08-49b3-973c-c68fa53c75ba",
    "type": "beneficiary",
    "attributes": {
      "name": "Schrute Farms",
      "agency": "0001",
      "account": "8146972-8",
      "documentNumber": "08470974000140",
      "bankCode": "274",
      "createdAt": "2024-04-18T16:32:44.093-03:00",
      "updatedAt": "2024-04-18T16:32:44.093-03:00",
      "releaseAt": "2024-04-18T16:32:44.094-03:00",
      "pixDetails": {
        "keyType": "evp",
        "key": "5561a2cb-24bb-4a82-b6f8-053b4ed1347c"
      }
    }
  }
}