v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Pagamentos

Criar iniciação de pagamento ou transferência

post/{companyId}/banking/payments

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002

Headers

x-idempotency-keystring

Example:f08jjj6b-00bc-1e3e-ad99-acb353333914

Request body

Example request

{
  "items": [
    {
      "detail": {
        "creditParty": {
          "name": "Nome",
          "taxId": "123412342134"
        },
        "emv": "123498128974239789gov-exemplo-de-emv1234123461"
      },
      "description": "Pagamento de boleto",
      "internalDescription": "Pagamento de boleto",
      "agreementId": "INDIVIDUAL_APPROVE",
      "batchId": "117610ad-dde4-4a55-94e4-24a9c9fc1fc4",
      "amount": 0.01,
      "debitParty": {
        "branchCode": "50",
        "number": "000000050"
      },
      "tags": {
        "externalId": "8725b04c-1354-4ad7-91db-4bbb2138e390"
      },
      "paymentDate": "2025-02-02"
    }
  ]
}

Response

Iniciação de Pagamento

batchIdstring

contractGuidstring

operationNeedsApprovalboolean required

Example response

{
  "batchId": "b9123459b123-123pgsf",
  "contractGuid": "123434545gpa234"
}