Skip to main content
GET
Consultar beneficiário com instruções e status de triagem

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

beneficiaryId
string
required

Response

Beneficiary

relationshipType
enum<string>
required

Titularidade da conta de destino. SELF_OWNED: o beneficiário é a mesma pessoa que o remetente (conta própria no Brasil). THIRD_PARTY: o beneficiário é outra pessoa ou empresa. No withdrawal, SELF_OWNED exige senderRelationship = SELF e THIRD_PARTY não aceita SELF.

Available options:
SELF_OWNED,
THIRD_PARTY
entity
object
required

INDIVIDUAL exige firstName e lastName; BUSINESS exige businessName. Endereço obrigatório para a triagem.

beneficiaryId
string
required
status
enum<string>
required

Situação do cadastro. Pode receber se ACTIVE e com ao menos uma instrução APPROVED.

Available options:
ACTIVE,
BLOCKED,
INACTIVE
paymentInstructions
object[]

Ao menos uma instrução APPROVED é necessária para criar um withdrawal para este beneficiário.

createdAt
string<date-time>
updatedAt
string<date-time>