跳到主要内容

创建自动划转规则

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​

字段类型描述字符数
transfer_cronstring*string以 CRON 格式表示的转账频率，这是一种用于表达循环周期的标准格式。CRON Guru
rule*enum要遵循的规则（split_equal 或 split_percentage）。枚举值
rule_configuration*object所选规则的配置对象。rule_configuration 对象
account_key*uuid作为转账来源账户的密钥。-

rule_configuration 对象​

字段类型描述字符数
destinationsobject目标账户及其他数据。destinations 数组
remaining_balancefloat将保留在账户中的余额金额。-

destinations 对象​

字段类型描述字符数
account_branch*string目标账户机构号。3
account_number*string目标账户号。3
account_digit*string目标账户检验位。3
document_number*string账户持有人证件号。3
name*string自然人姓名或法人公司名称。3
financial_institutions_code_number*string金融机构 COMPE 代码 (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf)3
financial_institutions_ispb*string金融机构 ISPB 号码。8
is_pix_transfer*boolean定义转账是否通过 PIX 进行。-
percentage*float分配给该账户的百分比。-

rule 枚举值​

枚举值说明
split_percentage按比例分配
split_equal均等分配
single_beneficiary单一受益人

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\"}"
}