跳到主要内容

创建付款批次

Request​

ENDPOINT
/settlement/fund_class/FUND_CLASS_KEY/payment_batch
MÉTODO
POST
Request Body
{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3", 
    "description": "PAGAMENOS - ABC - 2025-01-01",
    "account": {
        "account_number":"123456",
        "account_digit":"0",
        "account_branch": "0001",
        "financial_institution_code": "329",
    },
}

Body Params​

必填字段 *

字段类型描述字符数
external_id *string集成合作伙伴系统中此批次的唯一标识键。最多 50
account_keystring用于标识清算入账账户的字段36
accountJSON用于标识清算入账账户的字段-
descriptionstring清算批次描述255
reference_datestring清算参考日期。ISO 8601
end_to_end_idstring清算金融对手方的 PIX 标识符。32
source_document_numberstring清算金融对手方的文件号码。14 - 18
注意

account 和 account_key 字段均非必填，但若未作为参数传入，清算将在基金主账户中生成。两者不应同时传入。账户信息必须属于该基金旗下的账户。

Account​

字段类型描述字符数
account_numberstring账号最多 50
account_digitstring账号校验位1
account_branchstring账户支行最多 50
financial_institution_codestring金融机构代码3

Response​

STATUS
201
Response Body
{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "status": "pending_settlements_insertion",
    "description": "Lote de Pagamento - 2024-01-01 - 41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "fund_class_key": "4b8377d0-58ec-479f-8ee9-9f963d5c47ad",
    "payment_batch_key": "63f0dbec-e9c4-4943-929e-1d47b9edbb0b",
    "reference_date": "2024-01-01",
}

可能的错误​


STATUS
404
Response Body
{
  "title": "Fund Class not Found",
  "description": "Fund Class with key {fund_class_key} was not found.",
  "translation": "A Classe de Fundo com chave {fund_class_key} nao foi encontrado.",
  "code": "SET000005"
}

STATUS
400
Response Body
{
  "title": "Bad Request",
  "description": "Payment batch is being created in {accounting_date}, while fund is in {fund_class_accounting_date}",
  "translation": "Payment batch esta sendo criado em {accounting_date}, fundo esta em {fund_class_accounting_date}",
  "code": "SET000044"
}

STATUS
409
Response Body
{
  "title": "Payment batch external id already exists",
  "description": "The Payment Batch with external id {payment_batch_external_id} already exists",
  "translation": "O Lote de Pagamento com identificador externo {payment_batch_external_id} ja existe",
  "code": "SET000009"
}

STATUS
404
Response Body
{
  "title": "Account not found",
  "description": "The account with key ({account_key}) was not found.",
  "translation": "A conta com chave({account_key}) não foi encontrada.",
  "code": "SET000009"
}