Pular para o conteúdo principal

Criar regra de movimentação automática

Request​

ENDPOINT
/baas/automatic_transfer/transfer_configuration
MÉTODO
POST
Request Body
{
        "transfer_cronstring": "*/5 * * * *",
        "account_key": "6203037b-4405-4602-b7ce-ff99806d9cb0",
        "rule_configuration": {
          "destinations": [
            {
              "account_digit": "9",
              "financial_institutions_code_number": "063",
              "document_number": "48504807000198",
              "account_number": "1232046",
              "percentage": 100,
              "name": "Mateus Fonseca",
              "account_branch": "0931",
              "is_pix_transfer": false
            }
          ],
          "remaining_balance": 0
        },
        "is_active": true,
        "rule": "split_percentage"
}

BODY PARAMS​

CampoTipoDescriçãoCaracteres
transfer_cronstring*stringFrequência de transferência do dinheiro em CRON, padrão que permite expressar recorrência.CRON Guru
rule*enumRegra a ser seguida. (split_equal ou split_percentage).Enumeradores
rule_configuration*objectObjeto de configuração da regra escolhida.Objeto rule_configuration
account_key*uuidKey da conta origem das transferências.-

Obejto rule_configuration​

CampoTipoDescriçãoCaracteres
destinationsobjectContas destino e outros dados.Array of destination
remaining_balancefloatValor de saldo que irá permanecer na conta.-

Objeto destinations​

CampoTipoDescriçãoCaracteres
account_branch*stringAgência da conta destino.3
account_number*stringNúmero da conta destino.3
account_digit*stringDígito da conta destino.3
document_number*stringNúmero do documento do dono da conta.3
name*stringNome da pessoa física ou razão social da pessoa jurídica.3
financial_institutions_code_number*stringCódigo COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf)3
financial_institutions_ispb*stringNúmero ISPB da instituição financeira.8
is_pix_transfer*booleanDefine se a transferência será va pix.-
percentage*floatPorcentagem a ser destinada a essa conta.-

Enumeradores rule​

EnumeradorTradução
split_percentagedivisão percentual
split_equaldivisão igual
single_beneficiarybeneficiário único

Response​

STATUS
200
Response Body

{
  "account_key": "6203037b-4405-4602-b7ce-ff99806d9cb0",
  "automatic_transfer_key": "9284ef1d-3689-4bb0-8543-89fffab790a1",
  "rule": "split_percentage",
  "rule_configuration": {
    "destinations": [
      {
        "account_branch": "0931",
        "account_digit": "9",
        "account_number": "1232046",
        "document_number": "48504807000198",
        "financial_institutions_code_number": "063",
        "is_pix_transfer": false,
        "name": "Mateus Fonseca",
        "percentage": 100
      }
    ],
    "remaining_balance": 0
  },
  "status": "active",
  "transfer_cronstring": "*/5 * * * *"
}

STATUS
400
Response Body
{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}