API Reference

Submeter lote de pagamento

post
https://api.sandbox.empresas.btgpactual.com//banking/payroll/payments

Submete um lote de pagamentos para processamento assíncrono. Retorna 202 Accepted com o identificador do lote (paymentId e requestId).

O header X-Idempotency-Key (UUID v4) é obrigatório para evitar processamento duplicado em caso de retentativa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string | null
date-time
int32
enum

Tipo de operação de pagamento. Valores aceitos:

  • 2 = Salário (PAG_SALARIO)
  • 5 = PLR (Participação nos Lucros e Resultados) (PAG_PLR)
  • 9 = Férias (PAG_FERIAS)
  • 10 = Décimo Terceiro (PAG_DEC_TERCEIRO)
  • 11 = Rescisão (PAG_RESCISAO)
  • 12 = Prêmio / Bonificação (PAG_PREMIO)
  • 13 = Pagamento Genérico (Crédito em Conta) (PAG_CREDITO_EM_CONTA)
  • 14 = Distribuição de Dividendos (PAG_DIST_DIVIDENDOS)
  • 15 = Pagamento de Fornecedor (PAG_FORNECEDOR)
  • 17 = Adiantamento (PAG_ADIANTAMENTO)
  • 18 = Pró-labore (PAG_PROLABORE)
  • 19 = Bolsa Estágio (PAG_BOLSA_ESTAGIO)
  • 20 = Benefício (PAG_BENEFICIO)
  • 21 = Remuneração (PAG_REMUNERACAO)
  • 22 = Reembolso (PAG_REEMBOLSO)
  • 24 = Comissão (PAG_COMISSAO)
companies
array of objects | null
companies
Headers
uuid
required

Chave de idempotência (UUID v4). Evita processamento duplicado de requisições.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 4 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 4 days ago