Saltar al contenido

Cria ou executa payout settings

POST/api/payout-settings

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Sujeito a verificação de papel (RBAC).

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Cuerpo de la solicitud application/json

NombreTipoDescripción
bankCodeobligatoriostringCódigo do banco é obrigatório.
accountNumberobligatoriostringNúmero da conta é obrigatório.
accountDigitobligatoriostringDígito da conta é obrigatório.
branchNumberobligatoriostringNúmero da agência é obrigatório.
accountTypeobligatoriochecking | savings | checking_joint | savings_jointTipo da conta é obrigatório.
holderNameobligatoriostringNome do titular é obrigatório.
holderDocumentNumberobligatoriostringDocumento do titular é obrigatório.
transferEnabledopcionalbooleantransferEnabled deve ser boolean.
transferIntervalopcionaldaily | weekly | monthlyIntervalo de transferência inválido.
transferDayopcionalintegerDia de transferência deve estar entre 0 e 31.
automaticAnticipationEnabledopcionalbooleanautomaticAnticipationEnabled deve ser boolean.
anticipatableVolumePercentageopcionalintegerPorcentagem deve estar entre 0 e 100.

Respuestas

CódigoDescripción
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Ejemplo con 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"}'