Criação do Lote de Pagamento

---

Request

ENDPOINT

/settlement/fund_class/FUND_CLASS_KEY/payment_batch

MÉTODO

POST

Request Body

{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3", 
        "account": {
            "account_number":"123456",
            "account_digit":"0",
            "account_branch": "0001",
            "financial_institution_code": "329",
        },
}

Body Params

campo obrigatório *

Campo	Tipo	Descrição	Caracteres
external_id *	string	Chave única de identificação deste lote no sistema do parceiro integrador.	Até 50
account_key	string	Campo para identificar a conta da entrada da liquidação	36
account	JSON	Campo para identificar a conta da entrada da liquidação	-

Atenção

Os campos account e account_key não são campos obrigatórios, porém caso não sejam passados como parâmetro a liquidação será gerada na conta principal do fundo. Ambos não devem ser passados simultaneamente. As informações da conta devem ser referentes a uma conta pertencente ao fundo.

Account

Campo	Tipo	Descrição	Caracteres
account_number	string	Número da conta	Até 50
account_digit	string	Digito da conta	1
account_branch	string	Agência da conta	Até 50
financial_institution_code	string	Código da instituição financeira	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",
}

Possíveis erros

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