Cria ou executa payout settings
POST/api/payout-settings
- Auth
- Jeton requis
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Sujeito a verificação de papel (RBAC). O titular da conta precisa ser a própria empresa. Quando `holderDocumentNumber` vem, seus dígitos têm de ser os mesmos de `documentNumber` da informação comercial (o CNPJ na pessoa jurídica, o CPF na pessoa física; nunca o de um sócio); senão 400 com `errors[].param = "holderDocumentNumber"`. Basta a informação comercial estar salva (rascunho, em análise, aprovada ou recusada): os dados de recebimento podem ser preenchidos e enviados enquanto ela está em análise, e o SuperAdmin aprova os dois juntos. Sem informação comercial salva, 400 (`payout.businessInfoMissing`). Não há repasse automático nem antecipação. O recebedor da comunidade é criado com os dois desligados e o saque sai só quando a comunidade pede; os campos de repasse e antecipação deixaram de existir (no corpo, na resposta e no banco). Campos desconhecidos no corpo são ignorados.
En-têtes
| Nom | Type | Description |
|---|---|---|
If-Unmodified-Sincefacultatif | string | Opcional: a versão lida (`updatedAt` de `GET /api/payout-settings`), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409. |
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
bankCodeobligatoire | string | Código do banco é obrigatório. |
accountNumberobligatoire | string | Número da conta é obrigatório. |
accountDigitobligatoire | string | Dígito da conta é obrigatório. |
branchNumberobligatoire | string | Número da agência é obrigatório. |
accountTypeobligatoire | checking | savings | checking_joint | savings_joint | Tipo da conta é obrigatório. |
holderNameobligatoire | string | Nome do titular é obrigatório, com até 29 caracteres (limite do provedor de pagamento). · max 29 |
holderDocumentNumberobligatoire | string | Documento do titular é obrigatório. |
Réponses
| Statut | Description |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Comunidade da plataforma — os cadastros espelham o recebedor da própria Memberfy e são somente leitura. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/payout-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"bankCode":"string","accountNumber":"string","accountDigit":"string","branchNumber":"string","accountType":"checking","holderName":"string","holderDocumentNumber":"string"}'