Cria ou executa submit
POST/api/payout-settings/submit
- 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). Envia os dados bancários para análise. Recusa com 400 (`errors[].param = "holderDocumentNumber"`) quando o documento do titular não tem os mesmos dígitos do documento da informação comercial (a conta tem de ser da própria empresa, não de um sócio), e com 400 quando não há informação comercial salva. A informação comercial não precisa estar aprovada: com ela ainda em análise (ou em rascunho), o envio é aceito e a mensagem avisa que os dois cadastros serão analisados juntos. O recebedor no provedor só é criado quando os dois estão aprovados; se a informação comercial for recusada, os dados de recebimento não sobem sozinhos.
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
La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.
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/submit" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'