Consulta uma carteira de recebimento
/v1/wallets/{walletId}Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
walletIdstringobrigatórioIdentificador público (wall_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (wall_…)
namestringobrigatórioNome da conta bancária.
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).pixKeystringobrigatóriopode ser nuloChave Pix do destino;
nullquando é conta bancária.enabledbooleanobrigatórioSe a conta bancária pode receber saques (
falsedepois de arquivada).primarybooleanobrigatórioSe é o destino principal dos saques.
bankCodestringobrigatóriopode ser nuloCódigo do banco.
bankNamestringobrigatóriopode ser nuloNome do banco.
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
holderNamestringobrigatórioNome do titular da conta — sempre o dono da conta (a sua empresa).
accountTypestringobrigatórioTipo da conta (ex.:
checking).accountNumberstringobrigatóriopode ser nuloNúmero da conta.
routingNumberstringobrigatóriopode ser nuloAgência.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório