Skip to main content

Criação do Lote de Pagamento


Request

ENDPOINT
/settlement/fund_class/FUND_CLASS_KEY/payment_batch
METHOD
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 *

CampoTipoDescriçãoCaracteres
external_id *stringChave única de identificação deste lote no sistema do parceiro integrador.Até 50
account_keystringCampo para identificar a conta da entrada da liquidação36
accountJSONCampo 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

CampoTipoDescriçãoCaracteres
account_numberstringNúmero da contaAté 50
account_digitstringDigito da conta1
account_branchstringAgência da contaAté 50
financial_institution_codestringCódigo da instituição financeira3

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